Class CreateRemoteAccessSessionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateRemoteAccessSessionRequest.Builder,
CreateRemoteAccessSessionRequest>
Creates and submits a request to start a remote access session.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
clientId()
Unique identifier for the client.The configuration information for the remote access session request.final String
The ARN of the device for which you want to create a remote access session.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.final InteractionMode
The interaction mode of the remote access session.final String
The interaction mode of the remote access session.final String
name()
The name of the remote access session to create.final String
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.final Boolean
Set totrue
if you want to access devices remotely for debugging in your remote access session.final String
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.final Boolean
Set totrue
to enable remote recording for the remote access session.static Class
<? extends CreateRemoteAccessSessionRequest.Builder> final Boolean
When set totrue
, for private devices, Device Farm does not sign your app again.final String
Ignored.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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 ifremoteDebugEnabled
is set totrue
.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 ifremoteDebugEnabled
is set totrue
.Remote debugging is no longer supported.
-
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
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
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
The name of the remote access session to create.
- Returns:
- The name of the remote access session to create.
-
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 toCreateRemoteAccessSession
. This identifier is required only ifremoteDebugEnabled
is set totrue
.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 toCreateRemoteAccessSession
. This identifier is required only ifremoteDebugEnabled
is set totrue
.Remote debugging is no longer supported.
-
configuration
The configuration information for the remote access session request.
- Returns:
- The configuration information for the remote access session request.
-
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 returnInteractionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominteractionModeAsString()
.- 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
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 returnInteractionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominteractionModeAsString()
.- 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
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 interfaceToCopyableBuilder<CreateRemoteAccessSessionRequest.Builder,
CreateRemoteAccessSessionRequest> - Specified by:
toBuilder
in classDeviceFarmRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-