com.amazonaws.services.redshift.model

Class DescribeClusterSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshift.model.DescribeClusterSnapshotsRequest

All Implemented Interfaces:

Serializable

public class DescribeClusterSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the 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.

See Also:

AmazonRedshift.describeClusterSnapshots(DescribeClusterSnapshotsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeClusterSnapshotsRequest()

Method Summary

Methods

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 marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.
Integer	getMaxRecords() The maximum number of snapshot records to include in the response.
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.
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 marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.
void	setMaxRecords(Integer maxRecords) The maximum number of snapshot records to include in the response.
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.
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 marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.
DescribeClusterSnapshotsRequest	withMaxRecords(Integer maxRecords) The maximum number of snapshot records to include in the response.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeClusterSnapshotsRequest

public DescribeClusterSnapshotsRequest()

Method Detail

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.

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.

withClusterIdentifier

public DescribeClusterSnapshotsRequest withClusterIdentifier(String clusterIdentifier)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

withSnapshotIdentifier

public DescribeClusterSnapshotsRequest withSnapshotIdentifier(String snapshotIdentifier)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

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

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

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

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

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:

A reference to this updated object so that method calls can be chained together.

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

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

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

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

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:

A reference to this updated object so that method calls can be chained together.

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

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

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

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

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:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

public Integer getMaxRecords()

The maximum number of snapshot records to include in the response. If more records exist than the specified MaxRecords value, the response returns a marker that you can use in a subsequent DescribeClusterSnapshots request in order to retrieve the next set of snapshot records.

Default: 100

Constraints: Must be at least 20 and no more than 100.

Returns:

The maximum number of snapshot records to include in the response. If more records exist than the specified MaxRecords value, the response returns a marker that you can use in a subsequent DescribeClusterSnapshots request in order to retrieve the next set of snapshot records.

Default: 100

Constraints: Must be at least 20 and no more than 100.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of snapshot records to include in the response. If more records exist than the specified MaxRecords value, the response returns a marker that you can use in a subsequent DescribeClusterSnapshots request in order to retrieve the next set of snapshot records.

Default: 100

Constraints: Must be at least 20 and no more than 100.

Parameters:

maxRecords - The maximum number of snapshot records to include in the response. If more records exist than the specified MaxRecords value, the response returns a marker that you can use in a subsequent DescribeClusterSnapshots request in order to retrieve the next set of snapshot records.

Default: 100

Constraints: Must be at least 20 and no more than 100.

withMaxRecords

public DescribeClusterSnapshotsRequest withMaxRecords(Integer maxRecords)

The maximum number of snapshot records to include in the response. If more records exist than the specified MaxRecords value, the response returns a marker that you can use in a subsequent DescribeClusterSnapshots request in order to retrieve the next set of snapshot records.

Default: 100

Constraints: Must be at least 20 and no more than 100.

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

Parameters:

maxRecords - The maximum number of snapshot records to include in the response. If more records exist than the specified MaxRecords value, the response returns a marker that you can use in a subsequent DescribeClusterSnapshots request in order to retrieve the next set of snapshot records.

Default: 100

Constraints: Must be at least 20 and no more than 100.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

An optional marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.

Returns:

An optional marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.

setMarker

public void setMarker(String marker)

An optional marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.

Parameters:

marker - An optional marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.

withMarker

public DescribeClusterSnapshotsRequest withMarker(String marker)

An optional marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.

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

Parameters:

marker - An optional marker returned by a previous DescribeClusterSnapshots request to indicate the first snapshot that the request will return.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

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.

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

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:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object