Package software.amazon.awssdk.services.bedrockagentcore.model

Class ListBrowserSessionsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.ListBrowserSessionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListBrowserSessionsRequest.Builder,ListBrowserSessionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListBrowserSessionsRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<ListBrowserSessionsRequest.Builder,ListBrowserSessionsRequest>

  • Method Details

    • browserIdentifier

      public final String browserIdentifier()

      The unique identifier of the browser to list sessions for. If specified, only sessions for this browser are returned. If not specified, sessions for all browsers are returned.

      Returns:
      The unique identifier of the browser to list sessions for. If specified, only sessions for this browser are returned. If not specified, sessions for all browsers are returned.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in a single call. The default value is 10. Valid values range from 1 to 100. To retrieve the remaining results, make another call with the returned nextToken value.

      Returns:
      The maximum number of results to return in a single call. The default value is 10. Valid values range from 1 to 100. To retrieve the remaining results, make another call with the returned nextToken value.

    • nextToken

      public final String nextToken()

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. If not specified, Amazon Bedrock AgentCore returns the first page of results.

      Returns:
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. If not specified, Amazon Bedrock AgentCore returns the first page of results.

    • status

      public final BrowserSessionStatus status()

      The status of the browser sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.

      If the service returns an enum value that is not available in the current SDK version, status will return BrowserSessionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the browser sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the browser sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.

      If the service returns an enum value that is not available in the current SDK version, status will return BrowserSessionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the browser sessions to list. Valid values include ACTIVE, STOPPING, and STOPPED. If not specified, sessions with any status are returned.
      See Also:

    • toBuilder

      public ListBrowserSessionsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListBrowserSessionsRequest.Builder,ListBrowserSessionsRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest

    • builder

      public static ListBrowserSessionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListBrowserSessionsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo