Class DescribeClusterSnapshotsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.redshift.model.DescribeClusterSnapshotsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeClusterSnapshotsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeClusterSnapshotsRequest
clone()
Creates a shallow clone of this request.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(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(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
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.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.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setClusterIdentifier
public void setClusterIdentifier(String clusterIdentifier)
The identifier of the cluster for which information about snapshots is requested.
- Parameters:
clusterIdentifier
- The identifier of the cluster for which information about snapshots is requested.
-
getClusterIdentifier
public String getClusterIdentifier()
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.
-
withClusterIdentifier
public DescribeClusterSnapshotsRequest withClusterIdentifier(String clusterIdentifier)
The identifier of the cluster for which information about snapshots is requested.
- Parameters:
clusterIdentifier
- The identifier of the cluster for which information about snapshots is requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotIdentifier
public void setSnapshotIdentifier(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.
-
getSnapshotIdentifier
public String getSnapshotIdentifier()
The snapshot identifier of the snapshot about which to return information.
- Returns:
- The snapshot identifier of the snapshot about which to return information.
-
withSnapshotIdentifier
public DescribeClusterSnapshotsRequest withSnapshotIdentifier(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.
-
setSnapshotType
public void setSnapshotType(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
-
getSnapshotType
public String getSnapshotType()
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
-
withSnapshotType
public DescribeClusterSnapshotsRequest withSnapshotType(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.
-
setStartTime
public void setStartTime(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
- 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
-
getStartTime
public Date getStartTime()
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
-
withStartTime
public DescribeClusterSnapshotsRequest withStartTime(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
- 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.
-
setEndTime
public void setEndTime(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
- 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
-
getEndTime
public Date getEndTime()
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
-
withEndTime
public DescribeClusterSnapshotsRequest withEndTime(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
- 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.
-
setMaxRecords
public void setMaxRecords(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 amarker
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 specifiedMaxRecords
value, a value is returned in amarker
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.
-
getMaxRecords
public Integer getMaxRecords()
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 amarker
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 amarker
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.
-
withMaxRecords
public DescribeClusterSnapshotsRequest withMaxRecords(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 amarker
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 specifiedMaxRecords
value, a value is returned in amarker
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.
-
setMarker
public void setMarker(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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.
-
getMarker
public String getMarker()
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.
-
withMarker
public DescribeClusterSnapshotsRequest withMarker(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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOwnerAccount
public void setOwnerAccount(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.
-
getOwnerAccount
public String getOwnerAccount()
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.
-
withOwnerAccount
public DescribeClusterSnapshotsRequest withOwnerAccount(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.
-
getTagKeys
public 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. For example, suppose that you have snapshots that are tagged with keys called
owner
andenvironment
. 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
andenvironment
. 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.
-
setTagKeys
public 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. For example, suppose that you have snapshots that are tagged with keys called
owner
andenvironment
. 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 calledowner
andenvironment
. 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.
-
withTagKeys
public 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. For example, suppose that you have snapshots that are tagged with keys called
owner
andenvironment
. 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.NOTE: This method appends the values to the existing list (if any). Use
setTagKeys(java.util.Collection)
orwithTagKeys(java.util.Collection)
if you want to override the existing values.- 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 calledowner
andenvironment
. 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.
-
withTagKeys
public 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. For example, suppose that you have snapshots that are tagged with keys called
owner
andenvironment
. 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 calledowner
andenvironment
. 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.
-
getTagValues
public 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. For example, suppose that you have snapshots that are tagged with values called
admin
andtest
. 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
andtest
. 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.
-
setTagValues
public 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. For example, suppose that you have snapshots that are tagged with values called
admin
andtest
. 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 calledadmin
andtest
. 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.
-
withTagValues
public 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. For example, suppose that you have snapshots that are tagged with values called
admin
andtest
. 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.NOTE: This method appends the values to the existing list (if any). Use
setTagValues(java.util.Collection)
orwithTagValues(java.util.Collection)
if you want to override the existing values.- 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 calledadmin
andtest
. 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.
-
withTagValues
public 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. For example, suppose that you have snapshots that are tagged with values called
admin
andtest
. 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 calledadmin
andtest
. 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.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeClusterSnapshotsRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-