Package software.amazon.awssdk.services.amp.model

Interface ListWorkspacesRequest.Builder

All Superinterfaces:
AmpRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<ListWorkspacesRequest.Builder,ListWorkspacesRequest>, SdkBuilder<ListWorkspacesRequest.Builder,ListWorkspacesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListWorkspacesRequest
public static interface ListWorkspacesRequest.Builder extends AmpRequest.Builder, SdkPojo, CopyableBuilder<ListWorkspacesRequest.Builder,ListWorkspacesRequest>

  • Method Details

    • alias

      ListWorkspacesRequest.Builder alias(String alias)

      If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

      Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

      Parameters:
      alias - If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

      Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

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

    • maxResults

      ListWorkspacesRequest.Builder maxResults(Integer maxResults)

      The maximum number of workspaces to return per request. The default is 100.

      Parameters:
      maxResults - The maximum number of workspaces to return per request. The default is 100.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListWorkspacesRequest.Builder nextToken(String nextToken)

      The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

      For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

      Parameters:
      nextToken - The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

      For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

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

    • overrideConfiguration

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

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