public class DescribeClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable
DescribeClusterSnapshots operation
.
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
If you specify both tag keys and tag values in the same request,
Amazon Redshift returns all snapshots that match any combination of
the specified keys and values. For example, if you have
owner
and environment
for tag keys, and
admin
and test
for tag values, all snapshots
that have any combination of those values are returned. Only snapshots
that you own are returned in the response; shared snapshots are not
returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
NOOP
Constructor and Description |
---|
DescribeClusterSnapshotsRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getClusterIdentifier()
The identifier of the cluster for which information about snapshots is
requested.
|
Date |
getEndTime()
A time value that requests only snapshots created at or before the
specified time.
|
String |
getMarker()
An optional parameter that specifies the starting point to return a
set of response records.
|
Integer |
getMaxRecords()
The maximum number of response records to return in each call.
|
String |
getOwnerAccount()
The AWS customer account used to create or copy the snapshot.
|
String |
getSnapshotIdentifier()
The snapshot identifier of the snapshot about which to return
information.
|
String |
getSnapshotType()
The type of snapshots for which you are requesting information.
|
Date |
getStartTime()
A value that requests only snapshots created at or after the specified
time.
|
List<String> |
getTagKeys()
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> |
getTagValues()
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.
|
int |
hashCode() |
void |
setClusterIdentifier(String clusterIdentifier)
The identifier of the cluster for which information about snapshots is
requested.
|
void |
setEndTime(Date endTime)
A time value that requests only snapshots created at or before the
specified time.
|
void |
setMarker(String marker)
An optional parameter that specifies the starting point to return a
set of response records.
|
void |
setMaxRecords(Integer maxRecords)
The maximum number of response records to return in each call.
|
void |
setOwnerAccount(String ownerAccount)
The AWS customer account used to create or copy the snapshot.
|
void |
setSnapshotIdentifier(String snapshotIdentifier)
The snapshot identifier of the snapshot about which to return
information.
|
void |
setSnapshotType(String snapshotType)
The type of snapshots for which you are requesting information.
|
void |
setStartTime(Date startTime)
A value that requests only snapshots created at or after the specified
time.
|
void |
setTagKeys(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.
|
void |
setTagValues(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.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeClusterSnapshotsRequest |
withClusterIdentifier(String clusterIdentifier)
The identifier of the cluster for which information about snapshots is
requested.
|
DescribeClusterSnapshotsRequest |
withEndTime(Date endTime)
A time value that requests only snapshots created at or before the
specified time.
|
DescribeClusterSnapshotsRequest |
withMarker(String marker)
An optional parameter that specifies the starting point to return a
set of response records.
|
DescribeClusterSnapshotsRequest |
withMaxRecords(Integer maxRecords)
The maximum number of response records to return in each call.
|
DescribeClusterSnapshotsRequest |
withOwnerAccount(String ownerAccount)
The AWS customer account used to create or copy the snapshot.
|
DescribeClusterSnapshotsRequest |
withSnapshotIdentifier(String snapshotIdentifier)
The snapshot identifier of the snapshot about which to return
information.
|
DescribeClusterSnapshotsRequest |
withSnapshotType(String snapshotType)
The type of snapshots for which you are requesting information.
|
DescribeClusterSnapshotsRequest |
withStartTime(Date startTime)
A value that requests only snapshots created at or after the specified
time.
|
DescribeClusterSnapshotsRequest |
withTagKeys(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 |
withTagKeys(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 |
withTagValues(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 |
withTagValues(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.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getClusterIdentifier()
public void setClusterIdentifier(String clusterIdentifier)
clusterIdentifier
- The identifier of the cluster for which information about snapshots is
requested.public DescribeClusterSnapshotsRequest withClusterIdentifier(String clusterIdentifier)
Returns a reference to this object so that method calls can be chained together.
clusterIdentifier
- The identifier of the cluster for which information about snapshots is
requested.public String getSnapshotIdentifier()
public void setSnapshotIdentifier(String snapshotIdentifier)
snapshotIdentifier
- The snapshot identifier of the snapshot about which to return
information.public DescribeClusterSnapshotsRequest withSnapshotIdentifier(String snapshotIdentifier)
Returns a reference to this object so that method calls can be chained together.
snapshotIdentifier
- The snapshot identifier of the snapshot about which to return
information.public String getSnapshotType()
Valid Values:
automated
| manual
Valid Values:
automated
| manual
public void setSnapshotType(String snapshotType)
Valid Values:
automated
| manual
snapshotType
- The type of snapshots for which you are requesting information. By
default, snapshots of all types are returned. Valid Values:
automated
| manual
public DescribeClusterSnapshotsRequest withSnapshotType(String snapshotType)
Valid Values:
automated
| manual
Returns a reference to this object so that method calls can be chained together.
snapshotType
- The type of snapshots for which you are requesting information. By
default, snapshots of all types are returned. Valid Values:
automated
| manual
public Date getStartTime()
Example: 2012-07-16T18:00:00Z
Example: 2012-07-16T18:00:00Z
public void setStartTime(Date startTime)
Example: 2012-07-16T18:00:00Z
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
public DescribeClusterSnapshotsRequest withStartTime(Date startTime)
Example: 2012-07-16T18:00:00Z
Returns a reference to this object so that method calls can be chained together.
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
public Date getEndTime()
Example: 2012-07-16T18:00:00Z
Example: 2012-07-16T18:00:00Z
public void setEndTime(Date endTime)
Example: 2012-07-16T18:00:00Z
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
public DescribeClusterSnapshotsRequest withEndTime(Date endTime)
Example: 2012-07-16T18:00:00Z
Returns a reference to this object so that method calls can be chained together.
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
public Integer getMaxRecords()
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 void setMaxRecords(Integer maxRecords)
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
- 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.
public DescribeClusterSnapshotsRequest withMaxRecords(Integer maxRecords)
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 a reference to this object so that method calls can be chained together.
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.
public String getMarker()
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 void setMarker(String marker)
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.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.public DescribeClusterSnapshotsRequest withMarker(String marker)
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 a reference to this object so that method calls can be chained together.
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.public String getOwnerAccount()
public void setOwnerAccount(String ownerAccount)
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 DescribeClusterSnapshotsRequest withOwnerAccount(String ownerAccount)
Returns a reference to this object so that method calls can be chained together.
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> getTagKeys()
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.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 void setTagKeys(Collection<String> tagKeys)
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.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.public DescribeClusterSnapshotsRequest withTagKeys(String... tagKeys)
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 reference to this object so that method calls can be chained together.
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.public DescribeClusterSnapshotsRequest withTagKeys(Collection<String> tagKeys)
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 reference to this object so that method calls can be chained together.
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.public List<String> getTagValues()
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.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 void setTagValues(Collection<String> tagValues)
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.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.public DescribeClusterSnapshotsRequest withTagValues(String... tagValues)
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 reference to this object so that method calls can be chained together.
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.public DescribeClusterSnapshotsRequest withTagValues(Collection<String> tagValues)
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 reference to this object so that method calls can be chained together.
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.public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.