Package software.amazon.awssdk.services.devicefarm.model

Interface RemoteAccessSession.Builder

    • Method Detail

      • arn

        RemoteAccessSession.Builder arn​(String 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

        RemoteAccessSession.Builder name​(String 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

        RemoteAccessSession.Builder created​(Instant 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

        RemoteAccessSession.Builder status​(String 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:
        ExecutionStatus, ExecutionStatus

      • status

        RemoteAccessSession.Builder status​(ExecutionStatus 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:
        ExecutionStatus, ExecutionStatus

      • result

        RemoteAccessSession.Builder result​(String 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:
        ExecutionResult, ExecutionResult

      • result

        RemoteAccessSession.Builder result​(ExecutionResult 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:
        ExecutionResult, ExecutionResult

      • message

        RemoteAccessSession.Builder message​(String 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

        RemoteAccessSession.Builder started​(Instant 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

        RemoteAccessSession.Builder stopped​(Instant 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

        RemoteAccessSession.Builder device​(Device 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.

      • 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.

      • remoteDebugEnabled

        RemoteAccessSession.Builder remoteDebugEnabled​(Boolean remoteDebugEnabled)

        This flag is set to true if remote debugging is enabled for the remote access session.

        Remote debugging is no longer supported.

        Parameters:
        remoteDebugEnabled - This flag is set to true 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.

      • remoteRecordEnabled

        RemoteAccessSession.Builder remoteRecordEnabled​(Boolean remoteRecordEnabled)

        This flag is set to true if remote recording is enabled for the remote access session.

        Parameters:
        remoteRecordEnabled - This flag is set to true if remote recording is enabled for the remote access session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • remoteRecordAppArn

        RemoteAccessSession.Builder remoteRecordAppArn​(String remoteRecordAppArn)

        The ARN for the app to be recorded in the remote access session.

        Parameters:
        remoteRecordAppArn - The 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.

      • hostAddress

        RemoteAccessSession.Builder hostAddress​(String hostAddress)

        IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.

        Remote debugging is no longer supported.

        Parameters:
        hostAddress - IP address of the EC2 host where you need to connect to remotely debug devices. 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.

      • clientId

        RemoteAccessSession.Builder clientId​(String clientId)

        Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.

        Remote debugging is no longer supported.

        Parameters:
        clientId - Unique identifier of your client for the remote access session. 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.

      • 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, BillingMethod

      • 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.

      • endpoint

        RemoteAccessSession.Builder endpoint​(String endpoint)

        The endpoint for the remote access sesssion.

        Parameters:
        endpoint - The endpoint for the remote access sesssion.
        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

        RemoteAccessSession.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

        RemoteAccessSession.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

        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.