Interface DescribeGlobalClustersRequest.Builder

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

  • Method Details

    • globalClusterIdentifier

      DescribeGlobalClustersRequest.Builder globalClusterIdentifier(String globalClusterIdentifier)

      The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match an existing DBClusterIdentifier.

      Parameters:
      globalClusterIdentifier - The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match an existing DBClusterIdentifier.

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

    • filters

      DescribeGlobalClustersRequest.Builder filters(Collection<Filter> filters)

      A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

      Currently, the only supported filter is region.

      If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

      Parameters:
      filters - A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

      Currently, the only supported filter is region.

      If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

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

    • filters

      DescribeGlobalClustersRequest.Builder filters(Filter... filters)

      A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

      Currently, the only supported filter is region.

      If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

      Parameters:
      filters - A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

      Currently, the only supported filter is region.

      If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

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

    • filters

      DescribeGlobalClustersRequest.Builder filters(Consumer<Filter.Builder>... filters)

      A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

      Currently, the only supported filter is region.

      If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

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

    • maxRecords

      DescribeGlobalClustersRequest.Builder maxRecords(Integer maxRecords)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

      Parameters:
      maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

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

    • marker

      DescribeGlobalClustersRequest.Builder marker(String marker)

      An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Parameters:
      marker - An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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