@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateRemoteAccessSessionRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Creates and submits a request to start a remote access session.
NOOP
Constructor and Description |
---|
CreateRemoteAccessSessionRequest() |
Modifier and Type | Method and Description |
---|---|
CreateRemoteAccessSessionRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getClientId()
Unique identifier for the client.
|
CreateRemoteAccessSessionConfiguration |
getConfiguration()
The configuration information for the remote access session request.
|
String |
getDeviceArn()
The ARN of the device for which you want to create a remote access session.
|
String |
getInstanceArn()
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
|
String |
getInteractionMode()
The interaction mode of the remote access session.
|
String |
getName()
The name of the remote access session to create.
|
String |
getProjectArn()
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
|
Boolean |
getRemoteDebugEnabled()
Set to
true if you want to access devices remotely for debugging in your remote access session. |
String |
getRemoteRecordAppArn()
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
|
Boolean |
getRemoteRecordEnabled()
Set to
true to enable remote recording for the remote access session. |
Boolean |
getSkipAppResign()
When set to
true , for private devices, Device Farm does not sign your app again. |
String |
getSshPublicKey()
Ignored.
|
int |
hashCode() |
Boolean |
isRemoteDebugEnabled()
Set to
true if you want to access devices remotely for debugging in your remote access session. |
Boolean |
isRemoteRecordEnabled()
Set to
true to enable remote recording for the remote access session. |
Boolean |
isSkipAppResign()
When set to
true , for private devices, Device Farm does not sign your app again. |
void |
setClientId(String clientId)
Unique identifier for the client.
|
void |
setConfiguration(CreateRemoteAccessSessionConfiguration configuration)
The configuration information for the remote access session request.
|
void |
setDeviceArn(String deviceArn)
The ARN of the device for which you want to create a remote access session.
|
void |
setInstanceArn(String instanceArn)
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
|
void |
setInteractionMode(String interactionMode)
The interaction mode of the remote access session.
|
void |
setName(String name)
The name of the remote access session to create.
|
void |
setProjectArn(String projectArn)
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
|
void |
setRemoteDebugEnabled(Boolean remoteDebugEnabled)
Set to
true if you want to access devices remotely for debugging in your remote access session. |
void |
setRemoteRecordAppArn(String remoteRecordAppArn)
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
|
void |
setRemoteRecordEnabled(Boolean remoteRecordEnabled)
Set to
true to enable remote recording for the remote access session. |
void |
setSkipAppResign(Boolean skipAppResign)
When set to
true , for private devices, Device Farm does not sign your app again. |
void |
setSshPublicKey(String sshPublicKey)
Ignored.
|
String |
toString()
Returns a string representation of this object.
|
CreateRemoteAccessSessionRequest |
withClientId(String clientId)
Unique identifier for the client.
|
CreateRemoteAccessSessionRequest |
withConfiguration(CreateRemoteAccessSessionConfiguration configuration)
The configuration information for the remote access session request.
|
CreateRemoteAccessSessionRequest |
withDeviceArn(String deviceArn)
The ARN of the device for which you want to create a remote access session.
|
CreateRemoteAccessSessionRequest |
withInstanceArn(String instanceArn)
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
|
CreateRemoteAccessSessionRequest |
withInteractionMode(InteractionMode interactionMode)
The interaction mode of the remote access session.
|
CreateRemoteAccessSessionRequest |
withInteractionMode(String interactionMode)
The interaction mode of the remote access session.
|
CreateRemoteAccessSessionRequest |
withName(String name)
The name of the remote access session to create.
|
CreateRemoteAccessSessionRequest |
withProjectArn(String projectArn)
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
|
CreateRemoteAccessSessionRequest |
withRemoteDebugEnabled(Boolean remoteDebugEnabled)
Set to
true if you want to access devices remotely for debugging in your remote access session. |
CreateRemoteAccessSessionRequest |
withRemoteRecordAppArn(String remoteRecordAppArn)
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
|
CreateRemoteAccessSessionRequest |
withRemoteRecordEnabled(Boolean remoteRecordEnabled)
Set to
true to enable remote recording for the remote access session. |
CreateRemoteAccessSessionRequest |
withSkipAppResign(Boolean skipAppResign)
When set to
true , for private devices, Device Farm does not sign your app again. |
CreateRemoteAccessSessionRequest |
withSshPublicKey(String sshPublicKey)
Ignored.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setProjectArn(String projectArn)
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
projectArn
- The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.public String getProjectArn()
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
public CreateRemoteAccessSessionRequest withProjectArn(String projectArn)
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
projectArn
- The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.public void setDeviceArn(String deviceArn)
The ARN of the device 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.public String getDeviceArn()
The ARN of the device for which you want to create a remote access session.
public CreateRemoteAccessSessionRequest withDeviceArn(String deviceArn)
The ARN of the device 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.public void setInstanceArn(String instanceArn)
The Amazon Resource Name (ARN) of the device instance 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.public String getInstanceArn()
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
public CreateRemoteAccessSessionRequest withInstanceArn(String instanceArn)
The Amazon Resource Name (ARN) of the device instance 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.public void setSshPublicKey(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.
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.
public String getSshPublicKey()
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.
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.
public CreateRemoteAccessSessionRequest withSshPublicKey(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.
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.
public void setRemoteDebugEnabled(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.
remoteDebugEnabled
- Set to true
if you want to access devices remotely for debugging in your remote access
session.
Remote debugging is no longer supported.
public Boolean getRemoteDebugEnabled()
Set to true
if you want to access devices remotely for debugging in your remote access session.
Remote debugging is no longer supported.
true
if you want to access devices remotely for debugging in your remote access
session.
Remote debugging is no longer supported.
public CreateRemoteAccessSessionRequest withRemoteDebugEnabled(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.
remoteDebugEnabled
- Set to true
if you want to access devices remotely for debugging in your remote access
session.
Remote debugging is no longer supported.
public Boolean isRemoteDebugEnabled()
Set to true
if you want to access devices remotely for debugging in your remote access session.
Remote debugging is no longer supported.
true
if you want to access devices remotely for debugging in your remote access
session.
Remote debugging is no longer supported.
public void setRemoteRecordEnabled(Boolean remoteRecordEnabled)
Set to true
to enable remote recording for the remote access session.
remoteRecordEnabled
- Set to true
to enable remote recording for the remote access session.public Boolean getRemoteRecordEnabled()
Set to true
to enable remote recording for the remote access session.
true
to enable remote recording for the remote access session.public CreateRemoteAccessSessionRequest withRemoteRecordEnabled(Boolean remoteRecordEnabled)
Set to true
to enable remote recording for the remote access session.
remoteRecordEnabled
- Set to true
to enable remote recording for the remote access session.public Boolean isRemoteRecordEnabled()
Set to true
to enable remote recording for the remote access session.
true
to enable remote recording for the remote access session.public void setRemoteRecordAppArn(String remoteRecordAppArn)
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
remoteRecordAppArn
- The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.public String getRemoteRecordAppArn()
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
public CreateRemoteAccessSessionRequest withRemoteRecordAppArn(String remoteRecordAppArn)
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
remoteRecordAppArn
- The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.public void setName(String name)
The name of the remote access session to create.
name
- The name of the remote access session to create.public String getName()
The name of the remote access session to create.
public CreateRemoteAccessSessionRequest withName(String name)
The name of the remote access session to create.
name
- The name of the remote access session to create.public void setClientId(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.
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.
public String getClientId()
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.
clientId
value in each call to CreateRemoteAccessSession
. This
identifier is required only if remoteDebugEnabled
is set to true
.
Remote debugging is no longer supported.
public CreateRemoteAccessSessionRequest withClientId(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.
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.
public void setConfiguration(CreateRemoteAccessSessionConfiguration configuration)
The configuration information for the remote access session request.
configuration
- The configuration information for the remote access session request.public CreateRemoteAccessSessionConfiguration getConfiguration()
The configuration information for the remote access session request.
public CreateRemoteAccessSessionRequest withConfiguration(CreateRemoteAccessSessionConfiguration configuration)
The configuration information for the remote access session request.
configuration
- The configuration information for the remote access session request.public void setInteractionMode(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.
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.
InteractionMode
public String getInteractionMode()
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.
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.
InteractionMode
public CreateRemoteAccessSessionRequest withInteractionMode(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.
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.
InteractionMode
public CreateRemoteAccessSessionRequest withInteractionMode(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.
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.
InteractionMode
public void setSkipAppResign(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?
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?
public Boolean getSkipAppResign()
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?
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?
public CreateRemoteAccessSessionRequest withSkipAppResign(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?
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?
public Boolean isSkipAppResign()
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?
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?
public String toString()
toString
in class Object
Object.toString()
public CreateRemoteAccessSessionRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()