AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest Class Reference

#include <CreateRemoteAccessSessionRequest.h>

+ Inheritance diagram for Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest:

Public Member Functions

 CreateRemoteAccessSessionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetProjectArn () const
 
bool ProjectArnHasBeenSet () const
 
void SetProjectArn (const Aws::String &value)
 
void SetProjectArn (Aws::String &&value)
 
void SetProjectArn (const char *value)
 
CreateRemoteAccessSessionRequestWithProjectArn (const Aws::String &value)
 
CreateRemoteAccessSessionRequestWithProjectArn (Aws::String &&value)
 
CreateRemoteAccessSessionRequestWithProjectArn (const char *value)
 
const Aws::StringGetDeviceArn () const
 
bool DeviceArnHasBeenSet () const
 
void SetDeviceArn (const Aws::String &value)
 
void SetDeviceArn (Aws::String &&value)
 
void SetDeviceArn (const char *value)
 
CreateRemoteAccessSessionRequestWithDeviceArn (const Aws::String &value)
 
CreateRemoteAccessSessionRequestWithDeviceArn (Aws::String &&value)
 
CreateRemoteAccessSessionRequestWithDeviceArn (const char *value)
 
const Aws::StringGetInstanceArn () const
 
bool InstanceArnHasBeenSet () const
 
void SetInstanceArn (const Aws::String &value)
 
void SetInstanceArn (Aws::String &&value)
 
void SetInstanceArn (const char *value)
 
CreateRemoteAccessSessionRequestWithInstanceArn (const Aws::String &value)
 
CreateRemoteAccessSessionRequestWithInstanceArn (Aws::String &&value)
 
CreateRemoteAccessSessionRequestWithInstanceArn (const char *value)
 
const Aws::StringGetSshPublicKey () const
 
bool SshPublicKeyHasBeenSet () const
 
void SetSshPublicKey (const Aws::String &value)
 
void SetSshPublicKey (Aws::String &&value)
 
void SetSshPublicKey (const char *value)
 
CreateRemoteAccessSessionRequestWithSshPublicKey (const Aws::String &value)
 
CreateRemoteAccessSessionRequestWithSshPublicKey (Aws::String &&value)
 
CreateRemoteAccessSessionRequestWithSshPublicKey (const char *value)
 
bool GetRemoteDebugEnabled () const
 
bool RemoteDebugEnabledHasBeenSet () const
 
void SetRemoteDebugEnabled (bool value)
 
CreateRemoteAccessSessionRequestWithRemoteDebugEnabled (bool value)
 
bool GetRemoteRecordEnabled () const
 
bool RemoteRecordEnabledHasBeenSet () const
 
void SetRemoteRecordEnabled (bool value)
 
CreateRemoteAccessSessionRequestWithRemoteRecordEnabled (bool value)
 
const Aws::StringGetRemoteRecordAppArn () const
 
bool RemoteRecordAppArnHasBeenSet () const
 
void SetRemoteRecordAppArn (const Aws::String &value)
 
void SetRemoteRecordAppArn (Aws::String &&value)
 
void SetRemoteRecordAppArn (const char *value)
 
CreateRemoteAccessSessionRequestWithRemoteRecordAppArn (const Aws::String &value)
 
CreateRemoteAccessSessionRequestWithRemoteRecordAppArn (Aws::String &&value)
 
CreateRemoteAccessSessionRequestWithRemoteRecordAppArn (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateRemoteAccessSessionRequestWithName (const Aws::String &value)
 
CreateRemoteAccessSessionRequestWithName (Aws::String &&value)
 
CreateRemoteAccessSessionRequestWithName (const char *value)
 
const Aws::StringGetClientId () const
 
bool ClientIdHasBeenSet () const
 
void SetClientId (const Aws::String &value)
 
void SetClientId (Aws::String &&value)
 
void SetClientId (const char *value)
 
CreateRemoteAccessSessionRequestWithClientId (const Aws::String &value)
 
CreateRemoteAccessSessionRequestWithClientId (Aws::String &&value)
 
CreateRemoteAccessSessionRequestWithClientId (const char *value)
 
const CreateRemoteAccessSessionConfigurationGetConfiguration () const
 
bool ConfigurationHasBeenSet () const
 
void SetConfiguration (const CreateRemoteAccessSessionConfiguration &value)
 
void SetConfiguration (CreateRemoteAccessSessionConfiguration &&value)
 
CreateRemoteAccessSessionRequestWithConfiguration (const CreateRemoteAccessSessionConfiguration &value)
 
CreateRemoteAccessSessionRequestWithConfiguration (CreateRemoteAccessSessionConfiguration &&value)
 
const InteractionModeGetInteractionMode () const
 
bool InteractionModeHasBeenSet () const
 
void SetInteractionMode (const InteractionMode &value)
 
void SetInteractionMode (InteractionMode &&value)
 
CreateRemoteAccessSessionRequestWithInteractionMode (const InteractionMode &value)
 
CreateRemoteAccessSessionRequestWithInteractionMode (InteractionMode &&value)
 
bool GetSkipAppResign () const
 
bool SkipAppResignHasBeenSet () const
 
void SetSkipAppResign (bool value)
 
CreateRemoteAccessSessionRequestWithSkipAppResign (bool value)
 
- Public Member Functions inherited from Aws::DeviceFarm::DeviceFarmRequest
virtual ~DeviceFarmRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 27 of file CreateRemoteAccessSessionRequest.h.

Constructor & Destructor Documentation

◆ CreateRemoteAccessSessionRequest()

Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::CreateRemoteAccessSessionRequest ( )

Member Function Documentation

◆ ClientIdHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::ClientIdHasBeenSet ( ) const
inline

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.

Definition at line 439 of file CreateRemoteAccessSessionRequest.h.

◆ ConfigurationHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::ConfigurationHasBeenSet ( ) const
inline

The configuration information for the remote access session request.

Definition at line 516 of file CreateRemoteAccessSessionRequest.h.

◆ DeviceArnHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::DeviceArnHasBeenSet ( ) const
inline

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

Definition at line 102 of file CreateRemoteAccessSessionRequest.h.

◆ GetClientId()

const Aws::String& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetClientId ( ) const
inline

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.

Definition at line 428 of file CreateRemoteAccessSessionRequest.h.

◆ GetConfiguration()

const CreateRemoteAccessSessionConfiguration& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetConfiguration ( ) const
inline

The configuration information for the remote access session request.

Definition at line 511 of file CreateRemoteAccessSessionRequest.h.

◆ GetDeviceArn()

const Aws::String& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetDeviceArn ( ) const
inline

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

Definition at line 96 of file CreateRemoteAccessSessionRequest.h.

◆ GetInstanceArn()

const Aws::String& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetInstanceArn ( ) const
inline

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

Definition at line 145 of file CreateRemoteAccessSessionRequest.h.

◆ GetInteractionMode()

const InteractionMode& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetInteractionMode ( ) const
inline

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.

Definition at line 550 of file CreateRemoteAccessSessionRequest.h.

◆ GetName()

const Aws::String& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetName ( ) const
inline

The name of the remote access session to create.

Definition at line 381 of file CreateRemoteAccessSessionRequest.h.

◆ GetProjectArn()

const Aws::String& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetProjectArn ( ) const
inline

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

Definition at line 47 of file CreateRemoteAccessSessionRequest.h.

◆ GetRemoteDebugEnabled()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetRemoteDebugEnabled ( ) const
inline

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

Remote debugging is no longer supported.

Definition at line 277 of file CreateRemoteAccessSessionRequest.h.

◆ GetRemoteRecordAppArn()

const Aws::String& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetRemoteRecordAppArn ( ) const
inline

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

Definition at line 333 of file CreateRemoteAccessSessionRequest.h.

◆ GetRemoteRecordEnabled()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetRemoteRecordEnabled ( ) const
inline

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

Definition at line 308 of file CreateRemoteAccessSessionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateRemoteAccessSessionRequest.h.

◆ GetSkipAppResign()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetSkipAppResign ( ) const
inline

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?

Definition at line 625 of file CreateRemoteAccessSessionRequest.h.

◆ GetSshPublicKey()

const Aws::String& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::GetSshPublicKey ( ) const
inline

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.

Definition at line 198 of file CreateRemoteAccessSessionRequest.h.

◆ InstanceArnHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::InstanceArnHasBeenSet ( ) const
inline

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

Definition at line 151 of file CreateRemoteAccessSessionRequest.h.

◆ InteractionModeHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::InteractionModeHasBeenSet ( ) const
inline

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.

Definition at line 563 of file CreateRemoteAccessSessionRequest.h.

◆ NameHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::NameHasBeenSet ( ) const
inline

The name of the remote access session to create.

Definition at line 386 of file CreateRemoteAccessSessionRequest.h.

◆ ProjectArnHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::ProjectArnHasBeenSet ( ) const
inline

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

Definition at line 53 of file CreateRemoteAccessSessionRequest.h.

◆ RemoteDebugEnabledHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::RemoteDebugEnabledHasBeenSet ( ) const
inline

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

Remote debugging is no longer supported.

Definition at line 285 of file CreateRemoteAccessSessionRequest.h.

◆ RemoteRecordAppArnHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::RemoteRecordAppArnHasBeenSet ( ) const
inline

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

Definition at line 339 of file CreateRemoteAccessSessionRequest.h.

◆ RemoteRecordEnabledHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::RemoteRecordEnabledHasBeenSet ( ) const
inline

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

Definition at line 314 of file CreateRemoteAccessSessionRequest.h.

◆ SerializePayload()

Aws::String Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientId() [1/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetClientId ( const Aws::String value)
inline

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.

Definition at line 450 of file CreateRemoteAccessSessionRequest.h.

◆ SetClientId() [2/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetClientId ( Aws::String &&  value)
inline

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.

Definition at line 461 of file CreateRemoteAccessSessionRequest.h.

◆ SetClientId() [3/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetClientId ( const char *  value)
inline

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.

Definition at line 472 of file CreateRemoteAccessSessionRequest.h.

◆ SetConfiguration() [1/2]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetConfiguration ( const CreateRemoteAccessSessionConfiguration value)
inline

The configuration information for the remote access session request.

Definition at line 521 of file CreateRemoteAccessSessionRequest.h.

◆ SetConfiguration() [2/2]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetConfiguration ( CreateRemoteAccessSessionConfiguration &&  value)
inline

The configuration information for the remote access session request.

Definition at line 526 of file CreateRemoteAccessSessionRequest.h.

◆ SetDeviceArn() [1/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetDeviceArn ( const Aws::String value)
inline

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

Definition at line 108 of file CreateRemoteAccessSessionRequest.h.

◆ SetDeviceArn() [2/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetDeviceArn ( Aws::String &&  value)
inline

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

Definition at line 114 of file CreateRemoteAccessSessionRequest.h.

◆ SetDeviceArn() [3/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetDeviceArn ( const char *  value)
inline

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

Definition at line 120 of file CreateRemoteAccessSessionRequest.h.

◆ SetInstanceArn() [1/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetInstanceArn ( const Aws::String value)
inline

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

Definition at line 157 of file CreateRemoteAccessSessionRequest.h.

◆ SetInstanceArn() [2/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetInstanceArn ( Aws::String &&  value)
inline

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

Definition at line 163 of file CreateRemoteAccessSessionRequest.h.

◆ SetInstanceArn() [3/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetInstanceArn ( const char *  value)
inline

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

Definition at line 169 of file CreateRemoteAccessSessionRequest.h.

◆ SetInteractionMode() [1/2]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetInteractionMode ( const InteractionMode value)
inline

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.

Definition at line 576 of file CreateRemoteAccessSessionRequest.h.

◆ SetInteractionMode() [2/2]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetInteractionMode ( InteractionMode &&  value)
inline

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.

Definition at line 589 of file CreateRemoteAccessSessionRequest.h.

◆ SetName() [1/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetName ( const Aws::String value)
inline

The name of the remote access session to create.

Definition at line 391 of file CreateRemoteAccessSessionRequest.h.

◆ SetName() [2/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetName ( Aws::String &&  value)
inline

The name of the remote access session to create.

Definition at line 396 of file CreateRemoteAccessSessionRequest.h.

◆ SetName() [3/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetName ( const char *  value)
inline

The name of the remote access session to create.

Definition at line 401 of file CreateRemoteAccessSessionRequest.h.

◆ SetProjectArn() [1/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetProjectArn ( const Aws::String value)
inline

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

Definition at line 59 of file CreateRemoteAccessSessionRequest.h.

◆ SetProjectArn() [2/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetProjectArn ( Aws::String &&  value)
inline

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

Definition at line 65 of file CreateRemoteAccessSessionRequest.h.

◆ SetProjectArn() [3/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetProjectArn ( const char *  value)
inline

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

Definition at line 71 of file CreateRemoteAccessSessionRequest.h.

◆ SetRemoteDebugEnabled()

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetRemoteDebugEnabled ( bool  value)
inline

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

Remote debugging is no longer supported.

Definition at line 293 of file CreateRemoteAccessSessionRequest.h.

◆ SetRemoteRecordAppArn() [1/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetRemoteRecordAppArn ( const Aws::String value)
inline

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

Definition at line 345 of file CreateRemoteAccessSessionRequest.h.

◆ SetRemoteRecordAppArn() [2/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetRemoteRecordAppArn ( Aws::String &&  value)
inline

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

Definition at line 351 of file CreateRemoteAccessSessionRequest.h.

◆ SetRemoteRecordAppArn() [3/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetRemoteRecordAppArn ( const char *  value)
inline

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

Definition at line 357 of file CreateRemoteAccessSessionRequest.h.

◆ SetRemoteRecordEnabled()

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetRemoteRecordEnabled ( bool  value)
inline

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

Definition at line 320 of file CreateRemoteAccessSessionRequest.h.

◆ SetSkipAppResign()

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetSkipAppResign ( bool  value)
inline

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?

Definition at line 643 of file CreateRemoteAccessSessionRequest.h.

◆ SetSshPublicKey() [1/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetSshPublicKey ( const Aws::String value)
inline

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.

Definition at line 218 of file CreateRemoteAccessSessionRequest.h.

◆ SetSshPublicKey() [2/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetSshPublicKey ( Aws::String &&  value)
inline

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.

Definition at line 228 of file CreateRemoteAccessSessionRequest.h.

◆ SetSshPublicKey() [3/3]

void Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SetSshPublicKey ( const char *  value)
inline

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.

Definition at line 238 of file CreateRemoteAccessSessionRequest.h.

◆ SkipAppResignHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SkipAppResignHasBeenSet ( ) const
inline

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?

Definition at line 634 of file CreateRemoteAccessSessionRequest.h.

◆ SshPublicKeyHasBeenSet()

bool Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::SshPublicKeyHasBeenSet ( ) const
inline

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.

Definition at line 208 of file CreateRemoteAccessSessionRequest.h.

◆ WithClientId() [1/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithClientId ( const Aws::String value)
inline

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.

Definition at line 483 of file CreateRemoteAccessSessionRequest.h.

◆ WithClientId() [2/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithClientId ( Aws::String &&  value)
inline

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.

Definition at line 494 of file CreateRemoteAccessSessionRequest.h.

◆ WithClientId() [3/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithClientId ( const char *  value)
inline

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.

Definition at line 505 of file CreateRemoteAccessSessionRequest.h.

◆ WithConfiguration() [1/2]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithConfiguration ( const CreateRemoteAccessSessionConfiguration value)
inline

The configuration information for the remote access session request.

Definition at line 531 of file CreateRemoteAccessSessionRequest.h.

◆ WithConfiguration() [2/2]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithConfiguration ( CreateRemoteAccessSessionConfiguration &&  value)
inline

The configuration information for the remote access session request.

Definition at line 536 of file CreateRemoteAccessSessionRequest.h.

◆ WithDeviceArn() [1/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithDeviceArn ( const Aws::String value)
inline

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

Definition at line 126 of file CreateRemoteAccessSessionRequest.h.

◆ WithDeviceArn() [2/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithDeviceArn ( Aws::String &&  value)
inline

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

Definition at line 132 of file CreateRemoteAccessSessionRequest.h.

◆ WithDeviceArn() [3/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithDeviceArn ( const char *  value)
inline

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

Definition at line 138 of file CreateRemoteAccessSessionRequest.h.

◆ WithInstanceArn() [1/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithInstanceArn ( const Aws::String value)
inline

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

Definition at line 175 of file CreateRemoteAccessSessionRequest.h.

◆ WithInstanceArn() [2/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithInstanceArn ( Aws::String &&  value)
inline

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

Definition at line 181 of file CreateRemoteAccessSessionRequest.h.

◆ WithInstanceArn() [3/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithInstanceArn ( const char *  value)
inline

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

Definition at line 187 of file CreateRemoteAccessSessionRequest.h.

◆ WithInteractionMode() [1/2]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithInteractionMode ( const InteractionMode value)
inline

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.

Definition at line 602 of file CreateRemoteAccessSessionRequest.h.

◆ WithInteractionMode() [2/2]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithInteractionMode ( InteractionMode &&  value)
inline

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.

Definition at line 615 of file CreateRemoteAccessSessionRequest.h.

◆ WithName() [1/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithName ( const Aws::String value)
inline

The name of the remote access session to create.

Definition at line 406 of file CreateRemoteAccessSessionRequest.h.

◆ WithName() [2/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithName ( Aws::String &&  value)
inline

The name of the remote access session to create.

Definition at line 411 of file CreateRemoteAccessSessionRequest.h.

◆ WithName() [3/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithName ( const char *  value)
inline

The name of the remote access session to create.

Definition at line 416 of file CreateRemoteAccessSessionRequest.h.

◆ WithProjectArn() [1/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithProjectArn ( const Aws::String value)
inline

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

Definition at line 77 of file CreateRemoteAccessSessionRequest.h.

◆ WithProjectArn() [2/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithProjectArn ( Aws::String &&  value)
inline

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

Definition at line 83 of file CreateRemoteAccessSessionRequest.h.

◆ WithProjectArn() [3/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithProjectArn ( const char *  value)
inline

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

Definition at line 89 of file CreateRemoteAccessSessionRequest.h.

◆ WithRemoteDebugEnabled()

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithRemoteDebugEnabled ( bool  value)
inline

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

Remote debugging is no longer supported.

Definition at line 301 of file CreateRemoteAccessSessionRequest.h.

◆ WithRemoteRecordAppArn() [1/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithRemoteRecordAppArn ( const Aws::String value)
inline

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

Definition at line 363 of file CreateRemoteAccessSessionRequest.h.

◆ WithRemoteRecordAppArn() [2/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithRemoteRecordAppArn ( Aws::String &&  value)
inline

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

Definition at line 369 of file CreateRemoteAccessSessionRequest.h.

◆ WithRemoteRecordAppArn() [3/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithRemoteRecordAppArn ( const char *  value)
inline

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

Definition at line 375 of file CreateRemoteAccessSessionRequest.h.

◆ WithRemoteRecordEnabled()

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithRemoteRecordEnabled ( bool  value)
inline

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

Definition at line 326 of file CreateRemoteAccessSessionRequest.h.

◆ WithSkipAppResign()

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithSkipAppResign ( bool  value)
inline

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?

Definition at line 652 of file CreateRemoteAccessSessionRequest.h.

◆ WithSshPublicKey() [1/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithSshPublicKey ( const Aws::String value)
inline

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.

Definition at line 248 of file CreateRemoteAccessSessionRequest.h.

◆ WithSshPublicKey() [2/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithSshPublicKey ( Aws::String &&  value)
inline

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.

Definition at line 258 of file CreateRemoteAccessSessionRequest.h.

◆ WithSshPublicKey() [3/3]

CreateRemoteAccessSessionRequest& Aws::DeviceFarm::Model::CreateRemoteAccessSessionRequest::WithSshPublicKey ( const char *  value)
inline

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.

Definition at line 268 of file CreateRemoteAccessSessionRequest.h.


The documentation for this class was generated from the following file: