Package software.amazon.awssdk.services.redshift.model

Class DescribeClusterSnapshotsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.redshift.model.DescribeClusterSnapshotsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeClusterSnapshotsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeClusterSnapshotsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeClusterSnapshotsRequest.Builder	builder()
String	clusterIdentifier()	The identifier of the cluster for which information about snapshots is requested.
Date	endTime()	A time value that requests only snapshots created at or before the specified time.
boolean	equals(Object obj)
int	hashCode()
String	marker()	An optional parameter that specifies the starting point to return a set of response records.
Integer	maxRecords()	The maximum number of response records to return in each call.
String	ownerAccount()	The AWS customer account used to create or copy the snapshot.
static Class<? extends DescribeClusterSnapshotsRequest.Builder>	serializableBuilderClass()
String	snapshotIdentifier()	The snapshot identifier of the snapshot about which to return information.
String	snapshotType()	The type of snapshots for which you are requesting information.
Date	startTime()	A value that requests only snapshots created at or after the specified time.
List<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.
List<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	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

clusterIdentifier

public String clusterIdentifier()

The identifier of the cluster for which information about snapshots is requested.

Returns:

The identifier of the cluster for which information about snapshots is requested.

snapshotIdentifier

public String snapshotIdentifier()

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

Returns:

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

snapshotType

public String snapshotType()

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

Valid Values: automated | manual

Returns:

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

Valid Values: automated | manual

startTime

public Date 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:

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

endTime

public Date 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:

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

maxRecords

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

Returns:

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.

marker

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

Returns:

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.

ownerAccount

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

Returns:

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.

tagKeys

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

Returns:

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.

tagValues

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

Returns:

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.

toBuilder

public DescribeClusterSnapshotsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>

Returns:

a builder for type T

builder

public static DescribeClusterSnapshotsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object