Interface StartBrowserSessionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreRequest.Builder, Buildable, CopyableBuilder<StartBrowserSessionRequest.Builder,StartBrowserSessionRequest>, SdkBuilder<StartBrowserSessionRequest.Builder,StartBrowserSessionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartBrowserSessionRequest
@Mutable @NotThreadSafe public static interface StartBrowserSessionRequest.Builder extends BedrockAgentCoreRequest.Builder, SdkPojo, CopyableBuilder<StartBrowserSessionRequest.Builder,StartBrowserSessionRequest>

  • Method Details

    • browserIdentifier

      StartBrowserSessionRequest.Builder browserIdentifier(String browserIdentifier)

      The unique identifier of the browser to use for this session. This identifier specifies which browser environment to initialize for the session.

      Parameters:
      browserIdentifier - The unique identifier of the browser to use for this session. This identifier specifies which browser environment to initialize for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      StartBrowserSessionRequest.Builder name(String name)

      The name of the browser session. This name helps you identify and manage the session. The name does not need to be unique.

      Parameters:
      name - The name of the browser session. This name helps you identify and manage the session. The name does not need to be unique.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionTimeoutSeconds

      StartBrowserSessionRequest.Builder sessionTimeoutSeconds(Integer sessionTimeoutSeconds)

      The time in seconds after which the session automatically terminates if there is no activity. The default value is 3600 seconds (1 hour). The minimum allowed value is 60 seconds, and the maximum allowed value is 28800 seconds (8 hours).

      Parameters:
      sessionTimeoutSeconds - The time in seconds after which the session automatically terminates if there is no activity. The default value is 3600 seconds (1 hour). The minimum allowed value is 60 seconds, and the maximum allowed value is 28800 seconds (8 hours).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • viewPort

      StartBrowserSessionRequest.Builder viewPort(ViewPort viewPort)

      The dimensions of the browser viewport for this session. This determines the visible area of the web content and affects how web pages are rendered. If not specified, Amazon Bedrock uses a default viewport size.

      Parameters:
      viewPort - The dimensions of the browser viewport for this session. This determines the visible area of the web content and affects how web pages are rendered. If not specified, Amazon Bedrock uses a default viewport size.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • viewPort

      default StartBrowserSessionRequest.Builder viewPort(Consumer<ViewPort.Builder> viewPort)

      The dimensions of the browser viewport for this session. This determines the visible area of the web content and affects how web pages are rendered. If not specified, Amazon Bedrock uses a default viewport size.

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

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

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

    • clientToken

      StartBrowserSessionRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. This parameter helps prevent the creation of duplicate sessions if there are temporary network issues.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartBrowserSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartBrowserSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.