Class RemoteAccessSession

java.lang.Object
software.amazon.awssdk.services.devicefarm.model.RemoteAccessSession
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RemoteAccessSession.Builder,RemoteAccessSession>
@Generated("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:

  • Method Details

    • arn

      public final 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 final String name()

      The name of the remote access session.

      Returns:
      The name of the remote access session.

    • created

      public final 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 final 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:

    • statusAsString

      public final 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:

    • result

      public final 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:

    • resultAsString

      public final 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:

    • message

      public final String message()

      A message about the remote access session.

      Returns:
      A message about the remote access session.

    • started

      public final 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 final 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 final 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 final String instanceArn()

      The ARN of the instance.

      Returns:
      The ARN of the instance.

    • remoteDebugEnabled

      public final 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 final 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 final 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 final 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 final 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 final 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:

    • billingMethodAsString

      public final 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:

    • deviceMinutes

      public final 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 final String endpoint()

      The endpoint for the remote access sesssion.

      Returns:
      The endpoint for the remote access sesssion.

    • deviceUdid

      public final 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 final 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:

    • interactionModeAsString

      public final 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:

    • skipAppResign

      public final 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.

    • vpcConfig

      public final VpcConfig vpcConfig()

      The VPC security groups and subnets that are attached to a project.

      Returns:
      The VPC security groups and subnets that are attached to a project.

    • toBuilder

      public RemoteAccessSession.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RemoteAccessSession.Builder,RemoteAccessSession>
      Returns:
      a builder for type T

    • builder

      public static RemoteAccessSession.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RemoteAccessSession.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.