Package software.amazon.awssdk.services.docdb.model

Interface DescribeGlobalClustersRequest.Builder

    • Method Detail

      • globalClusterIdentifier

        DescribeGlobalClustersRequest.Builder globalClusterIdentifier​(String globalClusterIdentifier)

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

        Parameters:
        globalClusterIdentifier - The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.
        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 DB clusters to describe.

        Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

        Parameters:
        filters - A filter that specifies one or more global DB clusters to describe.

        Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

        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 DB clusters to describe.

        Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

        Parameters:
        filters - A filter that specifies one or more global DB clusters to describe.

        Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

        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 DB clusters to describe.

        Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

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

        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:
        #filters(java.util.Collection)

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

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