CreateRemoteAccessSessionRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.devicefarm.model.DeviceFarmRequest
    - - software.amazon.awssdk.services.devicefarm.model.CreateRemoteAccessSessionRequest

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

@Generated(value="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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateRemoteAccessSessionRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateRemoteAccessSessionRequest.Builder`	`builder()`
`String`	`clientId()` Unique identifier for the client.
`CreateRemoteAccessSessionConfiguration`	`configuration()` The configuration information for the remote access session request.
`String`	`deviceArn()` The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`instanceArn()` The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
`InteractionMode`	`interactionMode()` The interaction mode of the remote access session.
`String`	`interactionModeAsString()` The interaction mode of the remote access session.
`String`	`name()` The name of the remote access session that you wish to create.
`String`	`projectArn()` The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
`Boolean`	`remoteDebugEnabled()` Set to `true` if you want to access devices remotely for debugging in your remote access session.
`String`	`remoteRecordAppArn()` The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
`Boolean`	`remoteRecordEnabled()` Set to `true` to enable remote recording for the remote access session.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateRemoteAccessSessionRequest.Builder>`	`serializableBuilderClass()`
`Boolean`	`skipAppResign()` When set to `true`, for private devices, Device Farm will not sign your app again.
`String`	`sshPublicKey()` The public key of the `ssh` key pair you want to use for connecting to remote devices in your remote debugging session.
`CreateRemoteAccessSessionRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - projectArn
```
public 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 String deviceArn()
```
    The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
  - instanceArn
```
public 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 String sshPublicKey()
```
    The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true.
    
    Returns:
    
    The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true.
  - remoteDebugEnabled
```
public Boolean remoteDebugEnabled()
```
    Set to true if you want to access devices remotely for debugging in your remote access session.
    
    Returns:
    
    Set to true if you want to access devices remotely for debugging in your remote access session.
  - remoteRecordEnabled
```
public 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 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 String name()
```
    The name of the remote access session that you wish to create.
    
    Returns:
    
    The name of the remote access session that you wish to create.
  - clientId
```
public 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 is required only if remoteDebugEnabled is set to true.
    
    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 is required only if remoteDebugEnabled is set to true.
  - configuration
```
public CreateRemoteAccessSessionConfiguration configuration()
```
    The configuration information for the remote access session request.
    
    Returns:
    
    The configuration information for the remote access session request.
  - 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 will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
    
    For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
    
    Returns:
    
    When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
    
    For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
  - toBuilder
```
public CreateRemoteAccessSessionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateRemoteAccessSessionRequest.Builder,CreateRemoteAccessSessionRequest>
    
    Specified by:
    
    toBuilder in class DeviceFarmRequest
  - builder
```
public static CreateRemoteAccessSessionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateRemoteAccessSessionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateRemoteAccessSessionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

projectArn

deviceArn

instanceArn

sshPublicKey

remoteDebugEnabled

remoteRecordEnabled

remoteRecordAppArn

name

clientId

configuration

interactionMode

interactionModeAsString

skipAppResign

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields