@Generated(value="software.amazon.awssdk:codegen") public class DescribeClusterSnapshotsRequest extends RedshiftRequest implements ToCopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeClusterSnapshotsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeClusterSnapshotsRequest.Builder |
builder() |
String |
clusterIdentifier()
The identifier of the cluster for which information about snapshots is requested.
|
Instant |
endTime()
A time value that requests only snapshots created at or before the specified time.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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.
|
Instant |
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() |
requestOverrideConfig
copy
public String clusterIdentifier()
The identifier of the cluster for which information about snapshots is requested.
public String snapshotIdentifier()
The snapshot identifier of the snapshot about which to return information.
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
Valid Values: automated
| manual
public 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
Example: 2012-07-16T18:00:00Z
public 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
Example: 2012-07-16T18:00:00Z
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.
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.
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.
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.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.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.public DescribeClusterSnapshotsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeClusterSnapshotsRequest.Builder,DescribeClusterSnapshotsRequest>
toBuilder
in class RedshiftRequest
public static DescribeClusterSnapshotsRequest.Builder builder()
public static Class<? extends DescribeClusterSnapshotsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.