Class CreateRemoteAccessSessionRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRemoteAccessSessionRequest.Builder,CreateRemoteAccessSessionRequest>

@Generated("software.amazon.awssdk:codegen") public final class CreateRemoteAccessSessionRequest extends DeviceFarmRequest implements ToCopyableBuilder<CreateRemoteAccessSessionRequest.Builder,CreateRemoteAccessSessionRequest>

Creates and submits a request to start a remote access session.

  • Method Details

    • projectArn

      public final String projectArn()

      The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

      Returns:
      The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
    • deviceArn

      public final String deviceArn()

      The ARN of the device for which you want to create a remote access session.

      Returns:
      The ARN of the device for which you want to create a remote access session.
    • instanceArn

      public final String instanceArn()

      The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

      Returns:
      The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
    • sshPublicKey

      public final String sshPublicKey()

      Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if remoteDebugEnabled is set to true.

      Remote debugging is no longer supported.

      Returns:
      Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if remoteDebugEnabled is set to true.

      Remote debugging is no longer supported.

    • remoteDebugEnabled

      public final Boolean remoteDebugEnabled()

      Set to true if you want to access devices remotely for debugging in your remote access session.

      Remote debugging is no longer supported.

      Returns:
      Set to true if you want to access devices remotely for debugging in your remote access session.

      Remote debugging is no longer supported.

    • remoteRecordEnabled

      public final Boolean remoteRecordEnabled()

      Set to true to enable remote recording for the remote access session.

      Returns:
      Set to true to enable remote recording for the remote access session.
    • remoteRecordAppArn

      public final String remoteRecordAppArn()

      The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.

      Returns:
      The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
    • name

      public final String name()

      The name of the remote access session to create.

      Returns:
      The name of the remote access session to create.
    • clientId

      public final String clientId()

      Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This identifier is required only if remoteDebugEnabled is set to true.

      Remote debugging is no longer supported.

      Returns:
      Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This identifier is required only if remoteDebugEnabled is set to true.

      Remote debugging is no longer supported.

    • configuration

      public final CreateRemoteAccessSessionConfiguration configuration()

      The configuration information for the remote access session request.

      Returns:
      The configuration information for the remote access session request.
    • 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 on how Device Farm modifies your uploads during tests, see Do you modify my app?

      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 on how Device Farm modifies your uploads during tests, see Do you modify my app?

    • 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<CreateRemoteAccessSessionRequest.Builder,CreateRemoteAccessSessionRequest>
      Specified by:
      toBuilder in class DeviceFarmRequest
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends CreateRemoteAccessSessionRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.