software.amazon.awssdk.services.devicefarm.model

Interface CreateRemoteAccessSessionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateRemoteAccessSessionRequest.Builder,CreateRemoteAccessSessionRequest>, DeviceFarmRequest.Builder, SdkBuilder<CreateRemoteAccessSessionRequest.Builder,CreateRemoteAccessSessionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateRemoteAccessSessionRequest

public static interface CreateRemoteAccessSessionRequest.Builder
extends DeviceFarmRequest.Builder, SdkPojo, CopyableBuilder<CreateRemoteAccessSessionRequest.Builder,CreateRemoteAccessSessionRequest>

Method Summary

Modifier and Type	Method and Description
CreateRemoteAccessSessionRequest.Builder	clientId(String clientId) Unique identifier for the client.
default CreateRemoteAccessSessionRequest.Builder	configuration(Consumer<CreateRemoteAccessSessionConfiguration.Builder> configuration) The configuration information for the remote access session request.
CreateRemoteAccessSessionRequest.Builder	configuration(CreateRemoteAccessSessionConfiguration configuration) The configuration information for the remote access session request.
CreateRemoteAccessSessionRequest.Builder	deviceArn(String deviceArn) The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
CreateRemoteAccessSessionRequest.Builder	instanceArn(String instanceArn) The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
CreateRemoteAccessSessionRequest.Builder	interactionMode(InteractionMode interactionMode) The interaction mode of the remote access session.
CreateRemoteAccessSessionRequest.Builder	interactionMode(String interactionMode) The interaction mode of the remote access session.
CreateRemoteAccessSessionRequest.Builder	name(String name) The name of the remote access session that you wish to create.
CreateRemoteAccessSessionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateRemoteAccessSessionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateRemoteAccessSessionRequest.Builder	projectArn(String projectArn) The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
CreateRemoteAccessSessionRequest.Builder	remoteDebugEnabled(Boolean remoteDebugEnabled) Set to true if you want to access devices remotely for debugging in your remote access session.
CreateRemoteAccessSessionRequest.Builder	remoteRecordAppArn(String remoteRecordAppArn) The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
CreateRemoteAccessSessionRequest.Builder	remoteRecordEnabled(Boolean remoteRecordEnabled) Set to true to enable remote recording for the remote access session.
CreateRemoteAccessSessionRequest.Builder	skipAppResign(Boolean skipAppResign) When set to true, for private devices, Device Farm will not sign your app again.
CreateRemoteAccessSessionRequest.Builder	sshPublicKey(String sshPublicKey) The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session.

Methods inherited from interface software.amazon.awssdk.services.devicefarm.model.DeviceFarmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

projectArn

CreateRemoteAccessSessionRequest.Builder projectArn(String projectArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

deviceArn

CreateRemoteAccessSessionRequest.Builder deviceArn(String deviceArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceArn

CreateRemoteAccessSessionRequest.Builder instanceArn(String instanceArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sshPublicKey

CreateRemoteAccessSessionRequest.Builder sshPublicKey(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

remoteDebugEnabled

CreateRemoteAccessSessionRequest.Builder remoteDebugEnabled(Boolean remoteDebugEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

remoteRecordEnabled

CreateRemoteAccessSessionRequest.Builder remoteRecordEnabled(Boolean remoteRecordEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

remoteRecordAppArn

CreateRemoteAccessSessionRequest.Builder remoteRecordAppArn(String remoteRecordAppArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateRemoteAccessSessionRequest.Builder name(String name)

The name of the remote access session that you wish to create.

Parameters:

name - The name of the remote access session that you wish to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientId

CreateRemoteAccessSessionRequest.Builder clientId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

configuration

CreateRemoteAccessSessionRequest.Builder configuration(CreateRemoteAccessSessionConfiguration configuration)

The configuration information for the remote access session request.

Parameters:

configuration - The configuration information for the remote access session request.

Returns:

Returns a reference to this object so that method calls can be chained together.

configuration

default CreateRemoteAccessSessionRequest.Builder configuration(Consumer<CreateRemoteAccessSessionConfiguration.Builder> configuration)

The configuration information for the remote access session request.

This is a convenience that creates an instance of the CreateRemoteAccessSessionConfiguration.Builder avoiding the need to create one manually via CreateRemoteAccessSessionConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(CreateRemoteAccessSessionConfiguration).

Parameters:

configuration - a consumer that will call methods on CreateRemoteAccessSessionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

configuration(CreateRemoteAccessSessionConfiguration)

interactionMode

CreateRemoteAccessSessionRequest.Builder interactionMode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InteractionMode, InteractionMode

interactionMode

CreateRemoteAccessSessionRequest.Builder interactionMode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InteractionMode, InteractionMode

skipAppResign

CreateRemoteAccessSessionRequest.Builder skipAppResign(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateRemoteAccessSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateRemoteAccessSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.