com.amazonaws.services.redshift.model
Class Snapshot

java.lang.Object
  com.amazonaws.services.redshift.model.Snapshot

All Implemented Interfaces:

Serializable

public class Snapshot
extends Object
implements Serializable

Describes a snapshot.

See Also:

Serialized Form

Constructor Summary

Snapshot()

Method Summary

boolean	equals(Object obj)
String	getAvailabilityZone() The Availability Zone in which the cluster was created.
Date	getClusterCreateTime() The time (UTC) when the cluster was originally created.
String	getClusterIdentifier() The identifier of the cluster for which the snapshot was taken.
String	getClusterVersion() The version ID of the Amazon Redshift engine that is running on the cluster.
String	getDBName() The name of the database that was created when the cluster was created.
Boolean	getEncrypted() If true, the data in the snapshot is encrypted at rest.
String	getMasterUsername() The master user name for the cluster.
String	getNodeType() The node type of the nodes in the cluster.
Integer	getNumberOfNodes() The number of nodes in the cluster.
Integer	getPort() The port that the cluster is listening on.
Date	getSnapshotCreateTime() The time (UTC) when Amazon Redshift began the snapshot.
String	getSnapshotIdentifier() The snapshot identifier that is provided in the request.
String	getSnapshotType() The snapshot type.
String	getStatus() The snapshot status.
String	getVpcId() The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
int	hashCode()
Boolean	isEncrypted() If true, the data in the snapshot is encrypted at rest.
void	setAvailabilityZone(String availabilityZone) The Availability Zone in which the cluster was created.
void	setClusterCreateTime(Date clusterCreateTime) The time (UTC) when the cluster was originally created.
void	setClusterIdentifier(String clusterIdentifier) The identifier of the cluster for which the snapshot was taken.
void	setClusterVersion(String clusterVersion) The version ID of the Amazon Redshift engine that is running on the cluster.
void	setDBName(String dBName) The name of the database that was created when the cluster was created.
void	setEncrypted(Boolean encrypted) If true, the data in the snapshot is encrypted at rest.
void	setMasterUsername(String masterUsername) The master user name for the cluster.
void	setNodeType(String nodeType) The node type of the nodes in the cluster.
void	setNumberOfNodes(Integer numberOfNodes) The number of nodes in the cluster.
void	setPort(Integer port) The port that the cluster is listening on.
void	setSnapshotCreateTime(Date snapshotCreateTime) The time (UTC) when Amazon Redshift began the snapshot.
void	setSnapshotIdentifier(String snapshotIdentifier) The snapshot identifier that is provided in the request.
void	setSnapshotType(String snapshotType) The snapshot type.
void	setStatus(String status) The snapshot status.
void	setVpcId(String vpcId) The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Snapshot	withAvailabilityZone(String availabilityZone) The Availability Zone in which the cluster was created.
Snapshot	withClusterCreateTime(Date clusterCreateTime) The time (UTC) when the cluster was originally created.
Snapshot	withClusterIdentifier(String clusterIdentifier) The identifier of the cluster for which the snapshot was taken.
Snapshot	withClusterVersion(String clusterVersion) The version ID of the Amazon Redshift engine that is running on the cluster.
Snapshot	withDBName(String dBName) The name of the database that was created when the cluster was created.
Snapshot	withEncrypted(Boolean encrypted) If true, the data in the snapshot is encrypted at rest.
Snapshot	withMasterUsername(String masterUsername) The master user name for the cluster.
Snapshot	withNodeType(String nodeType) The node type of the nodes in the cluster.
Snapshot	withNumberOfNodes(Integer numberOfNodes) The number of nodes in the cluster.
Snapshot	withPort(Integer port) The port that the cluster is listening on.
Snapshot	withSnapshotCreateTime(Date snapshotCreateTime) The time (UTC) when Amazon Redshift began the snapshot.
Snapshot	withSnapshotIdentifier(String snapshotIdentifier) The snapshot identifier that is provided in the request.
Snapshot	withSnapshotType(String snapshotType) The snapshot type.
Snapshot	withStatus(String status) The snapshot status.
Snapshot	withVpcId(String vpcId) The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Snapshot

public Snapshot()

Method Detail

getSnapshotIdentifier

public String getSnapshotIdentifier()

The snapshot identifier that is provided in the request.

Returns:

The snapshot identifier that is provided in the request.

setSnapshotIdentifier

public void setSnapshotIdentifier(String snapshotIdentifier)

The snapshot identifier that is provided in the request.

Parameters:

snapshotIdentifier - The snapshot identifier that is provided in the request.

withSnapshotIdentifier

public Snapshot withSnapshotIdentifier(String snapshotIdentifier)

The snapshot identifier that is provided in the request.

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

Parameters:

snapshotIdentifier - The snapshot identifier that is provided in the request.

Returns:

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

getClusterIdentifier

public String getClusterIdentifier()

The identifier of the cluster for which the snapshot was taken.

Returns:

The identifier of the cluster for which the snapshot was taken.

setClusterIdentifier

public void setClusterIdentifier(String clusterIdentifier)

The identifier of the cluster for which the snapshot was taken.

Parameters:

clusterIdentifier - The identifier of the cluster for which the snapshot was taken.

withClusterIdentifier

public Snapshot withClusterIdentifier(String clusterIdentifier)

The identifier of the cluster for which the snapshot was taken.

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

Parameters:

clusterIdentifier - The identifier of the cluster for which the snapshot was taken.

Returns:

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

getSnapshotCreateTime

public Date getSnapshotCreateTime()

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Returns:

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

setSnapshotCreateTime

public void setSnapshotCreateTime(Date snapshotCreateTime)

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Parameters:

snapshotCreateTime - The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

withSnapshotCreateTime

public Snapshot withSnapshotCreateTime(Date snapshotCreateTime)

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

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

Parameters:

snapshotCreateTime - The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Returns:

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

getStatus

public String getStatus()

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Returns:

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

setStatus

public void setStatus(String status)

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Parameters:

status - The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

withStatus

public Snapshot withStatus(String status)

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

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

Parameters:

status - The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Returns:

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

getPort

public Integer getPort()

The port that the cluster is listening on.

Returns:

The port that the cluster is listening on.

setPort

public void setPort(Integer port)

The port that the cluster is listening on.

Parameters:

port - The port that the cluster is listening on.

withPort

public Snapshot withPort(Integer port)

The port that the cluster is listening on.

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

Parameters:

port - The port that the cluster is listening on.

Returns:

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

getAvailabilityZone

public String getAvailabilityZone()

The Availability Zone in which the cluster was created.

Returns:

The Availability Zone in which the cluster was created.

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

The Availability Zone in which the cluster was created.

Parameters:

availabilityZone - The Availability Zone in which the cluster was created.

withAvailabilityZone

public Snapshot withAvailabilityZone(String availabilityZone)

The Availability Zone in which the cluster was created.

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

Parameters:

availabilityZone - The Availability Zone in which the cluster was created.

Returns:

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

getClusterCreateTime

public Date getClusterCreateTime()

The time (UTC) when the cluster was originally created.

Returns:

The time (UTC) when the cluster was originally created.

setClusterCreateTime

public void setClusterCreateTime(Date clusterCreateTime)

The time (UTC) when the cluster was originally created.

Parameters:

clusterCreateTime - The time (UTC) when the cluster was originally created.

withClusterCreateTime

public Snapshot withClusterCreateTime(Date clusterCreateTime)

The time (UTC) when the cluster was originally created.

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

Parameters:

clusterCreateTime - The time (UTC) when the cluster was originally created.

Returns:

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

getMasterUsername

public String getMasterUsername()

The master user name for the cluster.

Returns:

The master user name for the cluster.

setMasterUsername

public void setMasterUsername(String masterUsername)

The master user name for the cluster.

Parameters:

masterUsername - The master user name for the cluster.

withMasterUsername

public Snapshot withMasterUsername(String masterUsername)

The master user name for the cluster.

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

Parameters:

masterUsername - The master user name for the cluster.

Returns:

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

getClusterVersion

public String getClusterVersion()

The version ID of the Amazon Redshift engine that is running on the cluster.

Returns:

The version ID of the Amazon Redshift engine that is running on the cluster.

setClusterVersion

public void setClusterVersion(String clusterVersion)

The version ID of the Amazon Redshift engine that is running on the cluster.

Parameters:

clusterVersion - The version ID of the Amazon Redshift engine that is running on the cluster.

withClusterVersion

public Snapshot withClusterVersion(String clusterVersion)

The version ID of the Amazon Redshift engine that is running on the cluster.

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

Parameters:

clusterVersion - The version ID of the Amazon Redshift engine that is running on the cluster.

Returns:

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

getSnapshotType

public String getSnapshotType()

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Returns:

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

setSnapshotType

public void setSnapshotType(String snapshotType)

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Parameters:

snapshotType - The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

withSnapshotType

public Snapshot withSnapshotType(String snapshotType)

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

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

Parameters:

snapshotType - The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Returns:

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

getNodeType

public String getNodeType()

The node type of the nodes in the cluster.

Returns:

The node type of the nodes in the cluster.

setNodeType

public void setNodeType(String nodeType)

The node type of the nodes in the cluster.

Parameters:

nodeType - The node type of the nodes in the cluster.

withNodeType

public Snapshot withNodeType(String nodeType)

The node type of the nodes in the cluster.

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

Parameters:

nodeType - The node type of the nodes in the cluster.

Returns:

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

getNumberOfNodes

public Integer getNumberOfNodes()

The number of nodes in the cluster.

Returns:

The number of nodes in the cluster.

setNumberOfNodes

public void setNumberOfNodes(Integer numberOfNodes)

The number of nodes in the cluster.

Parameters:

numberOfNodes - The number of nodes in the cluster.

withNumberOfNodes

public Snapshot withNumberOfNodes(Integer numberOfNodes)

The number of nodes in the cluster.

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

Parameters:

numberOfNodes - The number of nodes in the cluster.

Returns:

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

getDBName

public String getDBName()

The name of the database that was created when the cluster was created.

Returns:

The name of the database that was created when the cluster was created.

setDBName

public void setDBName(String dBName)

The name of the database that was created when the cluster was created.

Parameters:

dBName - The name of the database that was created when the cluster was created.

withDBName

public Snapshot withDBName(String dBName)

The name of the database that was created when the cluster was created.

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

Parameters:

dBName - The name of the database that was created when the cluster was created.

Returns:

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

getVpcId

public String getVpcId()

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Returns:

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

setVpcId

public void setVpcId(String vpcId)

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Parameters:

vpcId - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

withVpcId

public Snapshot withVpcId(String vpcId)

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

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

Parameters:

vpcId - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Returns:

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

isEncrypted

public Boolean isEncrypted()

If true, the data in the snapshot is encrypted at rest.

Returns:

If true, the data in the snapshot is encrypted at rest.

setEncrypted

public void setEncrypted(Boolean encrypted)

If true, the data in the snapshot is encrypted at rest.

Parameters:

encrypted - If true, the data in the snapshot is encrypted at rest.

withEncrypted

public Snapshot withEncrypted(Boolean encrypted)

If true, the data in the snapshot is encrypted at rest.

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

Parameters:

encrypted - If true, the data in the snapshot is encrypted at rest.

Returns:

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

getEncrypted

public Boolean getEncrypted()

If true, the data in the snapshot is encrypted at rest.

Returns:

If true, the data in the snapshot is encrypted at rest.

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