Interface RemoteAccessSession.Builder

  • Method Details

    • arn

      The Amazon Resource Name (ARN) of the remote access session.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the remote access session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      The name of the remote access session.

      Parameters:
      name - The name of the remote access session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • created

      The date and time the remote access session was created.

      Parameters:
      created - The date and time the remote access session was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The status of the remote access session. Can be any of the following:

      • PENDING.

      • PENDING_CONCURRENCY.

      • PENDING_DEVICE.

      • PROCESSING.

      • SCHEDULING.

      • PREPARING.

      • RUNNING.

      • COMPLETED.

      • STOPPING.

      Parameters:
      status - The status of the remote access session. Can be any of the following:

      • PENDING.

      • PENDING_CONCURRENCY.

      • PENDING_DEVICE.

      • PROCESSING.

      • SCHEDULING.

      • PREPARING.

      • RUNNING.

      • COMPLETED.

      • STOPPING.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The status of the remote access session. Can be any of the following:

      • PENDING.

      • PENDING_CONCURRENCY.

      • PENDING_DEVICE.

      • PROCESSING.

      • SCHEDULING.

      • PREPARING.

      • RUNNING.

      • COMPLETED.

      • STOPPING.

      Parameters:
      status - The status of the remote access session. Can be any of the following:

      • PENDING.

      • PENDING_CONCURRENCY.

      • PENDING_DEVICE.

      • PROCESSING.

      • SCHEDULING.

      • PREPARING.

      • RUNNING.

      • COMPLETED.

      • STOPPING.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • result

      The result of the remote access session. Can be any of the following:

      • PENDING.

      • PASSED.

      • WARNED.

      • FAILED.

      • SKIPPED.

      • ERRORED.

      • STOPPED.

      Parameters:
      result - The result of the remote access session. Can be any of the following:

      • PENDING.

      • PASSED.

      • WARNED.

      • FAILED.

      • SKIPPED.

      • ERRORED.

      • STOPPED.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • result

      The result of the remote access session. Can be any of the following:

      • PENDING.

      • PASSED.

      • WARNED.

      • FAILED.

      • SKIPPED.

      • ERRORED.

      • STOPPED.

      Parameters:
      result - The result of the remote access session. Can be any of the following:

      • PENDING.

      • PASSED.

      • WARNED.

      • FAILED.

      • SKIPPED.

      • ERRORED.

      • STOPPED.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • message

      A message about the remote access session.

      Parameters:
      message - A message about the remote access session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • started

      The date and time the remote access session was started.

      Parameters:
      started - The date and time the remote access session was started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • stopped

      The date and time the remote access session was stopped.

      Parameters:
      stopped - The date and time the remote access session was stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • device

      The device (phone or tablet) used in the remote access session.

      Parameters:
      device - The device (phone or tablet) used in the remote access session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • device

      The device (phone or tablet) used in the remote access session.

      This is a convenience method that creates an instance of the Device.Builder avoiding the need to create one manually via Device.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to device(Device).

      Parameters:
      device - a consumer that will call methods on Device.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • instanceArn

      RemoteAccessSession.Builder instanceArn(String instanceArn)

      The ARN of the instance.

      Parameters:
      instanceArn - The ARN of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • billingMethod

      RemoteAccessSession.Builder billingMethod(String billingMethod)

      The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.

      Parameters:
      billingMethod - The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • billingMethod

      RemoteAccessSession.Builder billingMethod(BillingMethod billingMethod)

      The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.

      Parameters:
      billingMethod - The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • deviceMinutes

      RemoteAccessSession.Builder deviceMinutes(DeviceMinutes deviceMinutes)

      The number of minutes a device is used in a remote access session (including setup and teardown minutes).

      Parameters:
      deviceMinutes - The number of minutes a device is used in a remote access session (including setup and teardown minutes).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • deviceMinutes

      default RemoteAccessSession.Builder deviceMinutes(Consumer<DeviceMinutes.Builder> deviceMinutes)

      The number of minutes a device is used in a remote access session (including setup and teardown minutes).

      This is a convenience method that creates an instance of the DeviceMinutes.Builder avoiding the need to create one manually via DeviceMinutes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceMinutes(DeviceMinutes).

      Parameters:
      deviceMinutes - a consumer that will call methods on DeviceMinutes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • endpoint

      Deprecated.
      This field is deprecated, and is replaced by the new endpoints.interactiveEndpoint field.

      The endpoint for the remote access session. This field is deprecated, and is replaced by the new endpoints.interactiveEndpoint field.

      Parameters:
      endpoint - The endpoint for the remote access session. This field is deprecated, and is replaced by the new endpoints.interactiveEndpoint field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • deviceUdid

      RemoteAccessSession.Builder deviceUdid(String deviceUdid)

      Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.

      Remote debugging is no longer supported.

      Parameters:
      deviceUdid - Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.

      Remote debugging is no longer supported.

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

      @Deprecated RemoteAccessSession.Builder interactionMode(String interactionMode)
      Deprecated.
      Changing the interactive mode of Remote Access sessions is no longer available.

      The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.

      Parameters:
      interactionMode - The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • interactionMode

      @Deprecated RemoteAccessSession.Builder interactionMode(InteractionMode interactionMode)
      Deprecated.
      Changing the interactive mode of Remote Access sessions is no longer available.

      The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.

      Parameters:
      interactionMode - The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • skipAppResign

      RemoteAccessSession.Builder skipAppResign(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 about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

      Parameters:
      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 about how Device Farm re-signs your apps, 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.
    • vpcConfig

      RemoteAccessSession.Builder vpcConfig(VpcConfig vpcConfig)

      The VPC security groups and subnets that are attached to a project.

      Parameters:
      vpcConfig - The VPC security groups and subnets that are attached to a project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • vpcConfig

      default RemoteAccessSession.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

      The VPC security groups and subnets that are attached to a project.

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • deviceProxy

      RemoteAccessSession.Builder deviceProxy(DeviceProxy deviceProxy)

      The device proxy configured for the remote access session.

      Parameters:
      deviceProxy - The device proxy configured for the remote access session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • deviceProxy

      default RemoteAccessSession.Builder deviceProxy(Consumer<DeviceProxy.Builder> deviceProxy)

      The device proxy configured for the remote access session.

      This is a convenience method that creates an instance of the DeviceProxy.Builder avoiding the need to create one manually via DeviceProxy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceProxy(DeviceProxy).

      Parameters:
      deviceProxy - a consumer that will call methods on DeviceProxy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • appUpload

      RemoteAccessSession.Builder appUpload(String appUpload)

      The ARN for the app to be installed onto your device.

      Parameters:
      appUpload - The ARN for the app to be installed onto your device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endpoints

      Sets the value of the Endpoints property for this object.
      Parameters:
      endpoints - The new value for the Endpoints property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endpoints

      Sets the value of the Endpoints property for this object. This is a convenience method that creates an instance of the RemoteAccessEndpoints.Builder avoiding the need to create one manually via RemoteAccessEndpoints.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpoints(RemoteAccessEndpoints).

      Parameters:
      endpoints - a consumer that will call methods on RemoteAccessEndpoints.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: