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

Interface CreateRemoteAccessSessionRequest.Builder

    • 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 ARN of the device for which you want to create a remote access session.

        Parameters:
        deviceArn - The 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)

        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.

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

        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.

        Remote debugging is no longer supported.

        Parameters:
        remoteDebugEnabled - Set to true if you want to access devices remotely for debugging in your 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

        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 to create.

        Parameters:
        name - The name of the remote access session 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 identifier is required only if remoteDebugEnabled is set to true.

        Remote debugging is no longer supported.

        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 identifier is required only if remoteDebugEnabled is set to true.

        Remote debugging is no longer supported.

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

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

        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 on how Device Farm modifies your uploads during tests, see Do you modify my app?

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