RemoteAccessSession (AWS Java SDK :: Services :: AWS Device Farm 2.15.18 API)

java.lang.Object
- software.amazon.awssdk.services.devicefarm.model.RemoteAccessSession

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<RemoteAccessSession.Builder,RemoteAccessSession>

@Generated(value="software.amazon.awssdk:codegen")
public final class RemoteAccessSession
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RemoteAccessSession.Builder,RemoteAccessSession>

Represents information about the remote access session.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RemoteAccessSession.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RemoteAccessSession.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the remote access session.
`BillingMethod`	`billingMethod()` The billing method of the remote access session.
`String`	`billingMethodAsString()` The billing method of the remote access session.
`static RemoteAccessSession.Builder`	`builder()`
`String`	`clientId()` Unique identifier of your client for the remote access session.
`Instant`	`created()` The date and time the remote access session was created.
`Device`	`device()` The device (phone or tablet) used in the remote access session.
`DeviceMinutes`	`deviceMinutes()` The number of minutes a device is used in a remote access session (including setup and teardown minutes).
`String`	`deviceUdid()` Unique device identifier for the remote device.
`String`	`endpoint()` The endpoint for the remote access sesssion.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`hostAddress()` IP address of the EC2 host where you need to connect to remotely debug devices.
`String`	`instanceArn()` The ARN of the instance.
`InteractionMode`	`interactionMode()` The interaction mode of the remote access session.
`String`	`interactionModeAsString()` The interaction mode of the remote access session.
`String`	`message()` A message about the remote access session.
`String`	`name()` The name of the remote access session.
`Boolean`	`remoteDebugEnabled()` This flag is set to `true` if remote debugging is enabled for the remote access session.
`String`	`remoteRecordAppArn()` The ARN for the app to be recorded in the remote access session.
`Boolean`	`remoteRecordEnabled()` This flag is set to `true` if remote recording is enabled for the remote access session.
`ExecutionResult`	`result()` The result of the remote access session.
`String`	`resultAsString()` The result of the remote access session.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RemoteAccessSession.Builder>`	`serializableBuilderClass()`
`Boolean`	`skipAppResign()` When set to `true`, for private devices, Device Farm does not sign your app again.
`Instant`	`started()` The date and time the remote access session was started.
`ExecutionStatus`	`status()` The status of the remote access session.
`String`	`statusAsString()` The status of the remote access session.
`Instant`	`stopped()` The date and time the remote access session was stopped.
`RemoteAccessSession.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the remote access session.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the remote access session.
  - name
```
public String name()
```
    The name of the remote access session.
    
    Returns:
    
    The name of the remote access session.
  - created
```
public Instant created()
```
    The date and time the remote access session was created.
    
    Returns:
    
    The date and time the remote access session was created.
  - status
```
public ExecutionStatus status()
```
    The status of the remote access session. Can be any of the following:
    - PENDING.
    - PENDING_CONCURRENCY.
    - PENDING_DEVICE.
    - PROCESSING.
    - SCHEDULING.
    - PREPARING.
    - RUNNING.
    - COMPLETED.
    - STOPPING.
    If the service returns an enum value that is not available in the current SDK version, status will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the remote access session. Can be any of the following:
    
    PENDING.
    
    PENDING_CONCURRENCY.
    
    PENDING_DEVICE.
    
    PROCESSING.
    
    SCHEDULING.
    
    PREPARING.
    
    RUNNING.
    
    COMPLETED.
    
    STOPPING.
    See Also:
    
    ExecutionStatus
  - statusAsString
```
public String statusAsString()
```
    The status of the remote access session. Can be any of the following:
    - PENDING.
    - PENDING_CONCURRENCY.
    - PENDING_DEVICE.
    - PROCESSING.
    - SCHEDULING.
    - PREPARING.
    - RUNNING.
    - COMPLETED.
    - STOPPING.
    If the service returns an enum value that is not available in the current SDK version, status will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the remote access session. Can be any of the following:
    
    PENDING.
    
    PENDING_CONCURRENCY.
    
    PENDING_DEVICE.
    
    PROCESSING.
    
    SCHEDULING.
    
    PREPARING.
    
    RUNNING.
    
    COMPLETED.
    
    STOPPING.
    See Also:
    
    ExecutionStatus
  - result
```
public ExecutionResult result()
```
    The result of the remote access session. Can be any of the following:
    - PENDING.
    - PASSED.
    - WARNED.
    - FAILED.
    - SKIPPED.
    - ERRORED.
    - STOPPED.
    If the service returns an enum value that is not available in the current SDK version, result will return ExecutionResult.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultAsString().
    Returns:
    The result of the remote access session. Can be any of the following:
    
    PENDING.
    
    PASSED.
    
    WARNED.
    
    FAILED.
    
    SKIPPED.
    
    ERRORED.
    
    STOPPED.
    See Also:
    
    ExecutionResult
  - resultAsString
```
public String resultAsString()
```
    The result of the remote access session. Can be any of the following:
    - PENDING.
    - PASSED.
    - WARNED.
    - FAILED.
    - SKIPPED.
    - ERRORED.
    - STOPPED.
    If the service returns an enum value that is not available in the current SDK version, result will return ExecutionResult.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultAsString().
    Returns:
    The result of the remote access session. Can be any of the following:
    
    PENDING.
    
    PASSED.
    
    WARNED.
    
    FAILED.
    
    SKIPPED.
    
    ERRORED.
    
    STOPPED.
    See Also:
    
    ExecutionResult
  - message
```
public String message()
```
    A message about the remote access session.
    
    Returns:
    
    A message about the remote access session.
  - started
```
public Instant started()
```
    The date and time the remote access session was started.
    
    Returns:
    
    The date and time the remote access session was started.
  - stopped
```
public Instant stopped()
```
    The date and time the remote access session was stopped.
    
    Returns:
    
    The date and time the remote access session was stopped.
  - device
```
public Device device()
```
    The device (phone or tablet) used in the remote access session.
    
    Returns:
    
    The device (phone or tablet) used in the remote access session.
  - instanceArn
```
public String instanceArn()
```
    The ARN of the instance.
    
    Returns:
    
    The ARN of the instance.
  - remoteDebugEnabled
```
public Boolean remoteDebugEnabled()
```
    This flag is set to true if remote debugging is enabled for the remote access session.
    
    Remote debugging is no longer supported.
    
    Returns:
    
    This flag is set to true if remote debugging is enabled for the remote access session.
    
    Remote debugging is no longer supported.
  - remoteRecordEnabled
```
public Boolean remoteRecordEnabled()
```
    This flag is set to true if remote recording is enabled for the remote access session.
    
    Returns:
    
    This flag is set to true if remote recording is enabled for the remote access session.
  - remoteRecordAppArn
```
public String remoteRecordAppArn()
```
    The ARN for the app to be recorded in the remote access session.
    
    Returns:
    
    The ARN for the app to be recorded in the remote access session.
  - hostAddress
```
public String hostAddress()
```
    IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
    
    Remote debugging is no longer supported.
    
    Returns:
    
    IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
    
    Remote debugging is no longer supported.
  - clientId
```
public String clientId()
```
    Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
    
    Remote debugging is no longer supported.
    
    Returns:
    
    Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
    
    Remote debugging is no longer supported.
  - billingMethod
```
public BillingMethod billingMethod()
```
    The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.
    
    If the service returns an enum value that is not available in the current SDK version, billingMethod will return BillingMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingMethodAsString().
    
    Returns:
    
    The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.
    
    See Also:
    
    BillingMethod
  - billingMethodAsString
```
public String billingMethodAsString()
```
    The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.
    
    If the service returns an enum value that is not available in the current SDK version, billingMethod will return BillingMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingMethodAsString().
    
    Returns:
    
    The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.
    
    See Also:
    
    BillingMethod
  - deviceMinutes
```
public DeviceMinutes deviceMinutes()
```
    The number of minutes a device is used in a remote access session (including setup and teardown minutes).
    
    Returns:
    
    The number of minutes a device is used in a remote access session (including setup and teardown minutes).
  - endpoint
```
public String endpoint()
```
    The endpoint for the remote access sesssion.
    
    Returns:
    
    The endpoint for the remote access sesssion.
  - deviceUdid
```
public String deviceUdid()
```
    Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
    
    Remote debugging is no longer supported.
    
    Returns:
    
    Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
    
    Remote debugging is no longer supported.
  - interactionMode
```
public InteractionMode interactionMode()
```
    The interaction mode of the remote access session. Valid values are:
    - INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
    - NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
    - VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
    If the service returns an enum value that is not available in the current SDK version, interactionMode will return InteractionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interactionModeAsString().
    Returns:
    The interaction mode of the remote access session. Valid values are:
    
    INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
    
    NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
    
    VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
    See Also:
    
    InteractionMode
  - interactionModeAsString
```
public String interactionModeAsString()
```
    The interaction mode of the remote access session. Valid values are:
    - INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
    - NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
    - VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
    If the service returns an enum value that is not available in the current SDK version, interactionMode will return InteractionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interactionModeAsString().
    Returns:
    The interaction mode of the remote access session. Valid values are:
    
    INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
    
    NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
    
    VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
    See Also:
    
    InteractionMode
  - skipAppResign
```
public Boolean skipAppResign()
```
    When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.
    
    For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
    
    Returns:
    
    When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.
    
    For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
  - toBuilder
```
public RemoteAccessSession.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RemoteAccessSession.Builder,RemoteAccessSession>
  - builder
```
public static RemoteAccessSession.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RemoteAccessSession.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RemoteAccessSession

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

name

created

status

statusAsString

result

resultAsString

message

started

stopped

device

instanceArn

remoteDebugEnabled

remoteRecordEnabled

remoteRecordAppArn

hostAddress

clientId

billingMethod

billingMethodAsString

deviceMinutes

endpoint

deviceUdid

interactionMode

interactionModeAsString

skipAppResign

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields