software.amazon.awssdk.services.redshift.model

Interface DescribeClusterSnapshotsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>, RedshiftRequest.Builder, SdkBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeClusterSnapshotsRequest

public static interface DescribeClusterSnapshotsRequest.Builder
extends RedshiftRequest.Builder, SdkPojo, CopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeClusterSnapshotsRequest.Builder	clusterExists(Boolean clusterExists) A value that indicates whether to return snapshots only for an existing cluster.
DescribeClusterSnapshotsRequest.Builder	clusterIdentifier(String clusterIdentifier) The identifier of the cluster which generated the requested snapshots.
DescribeClusterSnapshotsRequest.Builder	endTime(Instant endTime) A time value that requests only snapshots created at or before the specified time.
DescribeClusterSnapshotsRequest.Builder	marker(String marker) An optional parameter that specifies the starting point to return a set of response records.
DescribeClusterSnapshotsRequest.Builder	maxRecords(Integer maxRecords) The maximum number of response records to return in each call.
DescribeClusterSnapshotsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribeClusterSnapshotsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
DescribeClusterSnapshotsRequest.Builder	ownerAccount(String ownerAccount) The AWS customer account used to create or copy the snapshot.
DescribeClusterSnapshotsRequest.Builder	snapshotIdentifier(String snapshotIdentifier) The snapshot identifier of the snapshot about which to return information.
DescribeClusterSnapshotsRequest.Builder	snapshotType(String snapshotType) The type of snapshots for which you are requesting information.
DescribeClusterSnapshotsRequest.Builder	sortingEntities(Collection<SnapshotSortingEntity> sortingEntities)
DescribeClusterSnapshotsRequest.Builder	sortingEntities(Consumer<SnapshotSortingEntity.Builder>... sortingEntities) This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder().
DescribeClusterSnapshotsRequest.Builder	sortingEntities(SnapshotSortingEntity... sortingEntities)
DescribeClusterSnapshotsRequest.Builder	startTime(Instant startTime) A value that requests only snapshots created at or after the specified time.
DescribeClusterSnapshotsRequest.Builder	tagKeys(Collection<String> tagKeys) A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys.
DescribeClusterSnapshotsRequest.Builder	tagKeys(String... tagKeys) A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys.
DescribeClusterSnapshotsRequest.Builder	tagValues(Collection<String> tagValues) A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values.
DescribeClusterSnapshotsRequest.Builder	tagValues(String... tagValues) A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values.

Methods inherited from interface software.amazon.awssdk.services.redshift.model.RedshiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clusterIdentifier

DescribeClusterSnapshotsRequest.Builder clusterIdentifier(String clusterIdentifier)

The identifier of the cluster which generated the requested snapshots.

Parameters:

clusterIdentifier - The identifier of the cluster which generated the requested snapshots.

Returns:

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

snapshotIdentifier

DescribeClusterSnapshotsRequest.Builder snapshotIdentifier(String snapshotIdentifier)

The snapshot identifier of the snapshot about which to return information.

Parameters:

snapshotIdentifier - The snapshot identifier of the snapshot about which to return information.

Returns:

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

snapshotType

DescribeClusterSnapshotsRequest.Builder snapshotType(String snapshotType)

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

Parameters:

snapshotType - The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

Returns:

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

startTime

DescribeClusterSnapshotsRequest.Builder startTime(Instant startTime)

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Parameters:

startTime - A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Returns:

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

endTime

DescribeClusterSnapshotsRequest.Builder endTime(Instant endTime)

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Parameters:

endTime - A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Returns:

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

maxRecords

DescribeClusterSnapshotsRequest.Builder maxRecords(Integer maxRecords)

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Parameters:

maxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Returns:

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

marker

DescribeClusterSnapshotsRequest.Builder marker(String marker)

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Parameters:

marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

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

ownerAccount

DescribeClusterSnapshotsRequest.Builder ownerAccount(String ownerAccount)

The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.

Parameters:

ownerAccount - The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.

Returns:

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

tagKeys

DescribeClusterSnapshotsRequest.Builder tagKeys(Collection<String> tagKeys)

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

Parameters:

tagKeys - A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

Returns:

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

tagKeys

DescribeClusterSnapshotsRequest.Builder tagKeys(String... tagKeys)

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

Parameters:

tagKeys - A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

Returns:

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

tagValues

DescribeClusterSnapshotsRequest.Builder tagValues(Collection<String> tagValues)

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

Parameters:

tagValues - A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

Returns:

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

tagValues

DescribeClusterSnapshotsRequest.Builder tagValues(String... tagValues)

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

Parameters:

tagValues - A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

Returns:

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

clusterExists

DescribeClusterSnapshotsRequest.Builder clusterExists(Boolean clusterExists)

A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

• If ClusterExists is set to true, ClusterIdentifier is required.

• If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

Parameters:

clusterExists - A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

• If ClusterExists is set to true, ClusterIdentifier is required.

• If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

• If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

Returns:

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

sortingEntities

DescribeClusterSnapshotsRequest.Builder sortingEntities(Collection<SnapshotSortingEntity> sortingEntities)

Parameters:

sortingEntities -

Returns:

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

sortingEntities

DescribeClusterSnapshotsRequest.Builder sortingEntities(SnapshotSortingEntity... sortingEntities)

Parameters:

sortingEntities -

Returns:

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

sortingEntities

DescribeClusterSnapshotsRequest.Builder sortingEntities(Consumer<SnapshotSortingEntity.Builder>... sortingEntities)

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #sortingEntities(List).

Parameters:

sortingEntities - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#sortingEntities(List)

overrideConfiguration

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

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