Class Snapshot
- java.lang.Object
-
- com.amazonaws.services.redshift.model.Snapshot
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class Snapshot extends Object implements Serializable, Cloneable
Describes a snapshot.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Snapshot()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Snapshot
clone()
boolean
equals(Object obj)
List<AccountWithRestoreAccess>
getAccountsWithRestoreAccess()
A list of the AWS customer accounts authorized to restore the snapshot.Double
getActualIncrementalBackupSizeInMegaBytes()
The size of the incremental backup.String
getAvailabilityZone()
The Availability Zone in which the cluster was created.Double
getBackupProgressInMegaBytes()
The number of megabytes that have been transferred to the snapshot backup.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.Double
getCurrentBackupRateInMegaBytesPerSecond()
The number of megabytes per second being transferred to the snapshot backup.String
getDBName()
The name of the database that was created when the cluster was created.Long
getElapsedTimeInSeconds()
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.Boolean
getEncrypted()
Iftrue
, the data in the snapshot is encrypted at rest.Boolean
getEncryptedWithHSM()
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.Long
getEstimatedSecondsToCompletion()
The estimate of the time remaining before the snapshot backup will complete.String
getKmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.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.String
getOwnerAccount()
For manual snapshots, the AWS customer account used to create or copy the snapshot.Integer
getPort()
The port that the cluster is listening on.List<String>
getRestorableNodeTypes()
The list of node types that this cluster snapshot is able to restore into.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
getSourceRegion()
The source region from which the snapshot was copied.String
getStatus()
The snapshot status.List<Tag>
getTags()
The list of tags for the cluster snapshot.Double
getTotalBackupSizeInMegaBytes()
The size of the complete set of backup data that would be used to restore the cluster.String
getVpcId()
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.int
hashCode()
Boolean
isEncrypted()
Iftrue
, the data in the snapshot is encrypted at rest.Boolean
isEncryptedWithHSM()
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.void
setAccountsWithRestoreAccess(Collection<AccountWithRestoreAccess> accountsWithRestoreAccess)
A list of the AWS customer accounts authorized to restore the snapshot.void
setActualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.void
setAvailabilityZone(String availabilityZone)
The Availability Zone in which the cluster was created.void
setBackupProgressInMegaBytes(Double backupProgressInMegaBytes)
The number of megabytes that have been transferred to the snapshot backup.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
setCurrentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)
The number of megabytes per second being transferred to the snapshot backup.void
setDBName(String dBName)
The name of the database that was created when the cluster was created.void
setElapsedTimeInSeconds(Long elapsedTimeInSeconds)
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.void
setEncrypted(Boolean encrypted)
Iftrue
, the data in the snapshot is encrypted at rest.void
setEncryptedWithHSM(Boolean encryptedWithHSM)
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.void
setEstimatedSecondsToCompletion(Long estimatedSecondsToCompletion)
The estimate of the time remaining before the snapshot backup will complete.void
setKmsKeyId(String kmsKeyId)
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.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
setOwnerAccount(String ownerAccount)
For manual snapshots, the AWS customer account used to create or copy the snapshot.void
setPort(Integer port)
The port that the cluster is listening on.void
setRestorableNodeTypes(Collection<String> restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.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
setSourceRegion(String sourceRegion)
The source region from which the snapshot was copied.void
setStatus(String status)
The snapshot status.void
setTags(Collection<Tag> tags)
The list of tags for the cluster snapshot.void
setTotalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)
The size of the complete set of backup data that would be used to restore the cluster.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
withAccountsWithRestoreAccess(AccountWithRestoreAccess... accountsWithRestoreAccess)
A list of the AWS customer accounts authorized to restore the snapshot.Snapshot
withAccountsWithRestoreAccess(Collection<AccountWithRestoreAccess> accountsWithRestoreAccess)
A list of the AWS customer accounts authorized to restore the snapshot.Snapshot
withActualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.Snapshot
withAvailabilityZone(String availabilityZone)
The Availability Zone in which the cluster was created.Snapshot
withBackupProgressInMegaBytes(Double backupProgressInMegaBytes)
The number of megabytes that have been transferred to the snapshot backup.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
withCurrentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)
The number of megabytes per second being transferred to the snapshot backup.Snapshot
withDBName(String dBName)
The name of the database that was created when the cluster was created.Snapshot
withElapsedTimeInSeconds(Long elapsedTimeInSeconds)
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.Snapshot
withEncrypted(Boolean encrypted)
Iftrue
, the data in the snapshot is encrypted at rest.Snapshot
withEncryptedWithHSM(Boolean encryptedWithHSM)
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.Snapshot
withEstimatedSecondsToCompletion(Long estimatedSecondsToCompletion)
The estimate of the time remaining before the snapshot backup will complete.Snapshot
withKmsKeyId(String kmsKeyId)
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.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
withOwnerAccount(String ownerAccount)
For manual snapshots, the AWS customer account used to create or copy the snapshot.Snapshot
withPort(Integer port)
The port that the cluster is listening on.Snapshot
withRestorableNodeTypes(String... restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.Snapshot
withRestorableNodeTypes(Collection<String> restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.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
withSourceRegion(String sourceRegion)
The source region from which the snapshot was copied.Snapshot
withStatus(String status)
The snapshot status.Snapshot
withTags(Tag... tags)
The list of tags for the cluster snapshot.Snapshot
withTags(Collection<Tag> tags)
The list of tags for the cluster snapshot.Snapshot
withTotalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)
The size of the complete set of backup data that would be used to restore the cluster.Snapshot
withVpcId(String vpcId)
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
-
-
-
Method Detail
-
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.
-
getSnapshotIdentifier
public String getSnapshotIdentifier()
The snapshot identifier that is provided in the request.
- Returns:
- The snapshot identifier that is provided in the request.
-
withSnapshotIdentifier
public Snapshot withSnapshotIdentifier(String snapshotIdentifier)
The snapshot identifier that is provided in the request.
- Parameters:
snapshotIdentifier
- The snapshot identifier that is provided in the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
withClusterIdentifier
public Snapshot withClusterIdentifier(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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", "final snapshot", 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", "final snapshot", or "failed".
- DeleteClusterSnapshot returns status as "deleted".
-
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", "final snapshot", 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", "final snapshot", 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", "final snapshot", 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", "final snapshot", or "failed".
- DeleteClusterSnapshot returns status as "deleted".
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPort
public void setPort(Integer port)
The port that the cluster is listening on.
- Parameters:
port
- The port that the cluster is listening on.
-
getPort
public Integer getPort()
The port that the cluster is listening on.
- Returns:
- The port that the cluster is listening on.
-
withPort
public Snapshot withPort(Integer port)
The port that the cluster is listening on.
- Parameters:
port
- The port that the cluster is listening on.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
getAvailabilityZone
public String getAvailabilityZone()
The Availability Zone in which the cluster was created.
- Returns:
- The Availability Zone in which the cluster was created.
-
withAvailabilityZone
public Snapshot withAvailabilityZone(String availabilityZone)
The Availability Zone in which the cluster was created.
- Parameters:
availabilityZone
- The Availability Zone in which the cluster was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
getClusterCreateTime
public Date getClusterCreateTime()
The time (UTC) when the cluster was originally created.
- Returns:
- The time (UTC) when the cluster was originally created.
-
withClusterCreateTime
public Snapshot withClusterCreateTime(Date clusterCreateTime)
The time (UTC) when the cluster was originally created.
- Parameters:
clusterCreateTime
- The time (UTC) when the cluster was originally created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMasterUsername
public void setMasterUsername(String masterUsername)
The master user name for the cluster.
- Parameters:
masterUsername
- The master user name for the cluster.
-
getMasterUsername
public String getMasterUsername()
The master user name for the cluster.
- Returns:
- The master user name for the cluster.
-
withMasterUsername
public Snapshot withMasterUsername(String masterUsername)
The master user name for the cluster.
- Parameters:
masterUsername
- The master user name for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
withClusterVersion
public Snapshot withClusterVersion(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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".
-
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".
-
withSnapshotType
public Snapshot withSnapshotType(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".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
getNodeType
public String getNodeType()
The node type of the nodes in the cluster.
- Returns:
- The node type of the nodes in the cluster.
-
withNodeType
public Snapshot withNodeType(String nodeType)
The node type of the nodes in the cluster.
- Parameters:
nodeType
- The node type of the nodes in the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNumberOfNodes
public void setNumberOfNodes(Integer numberOfNodes)
The number of nodes in the cluster.
- Parameters:
numberOfNodes
- The number of nodes in the cluster.
-
getNumberOfNodes
public Integer getNumberOfNodes()
The number of nodes in the cluster.
- Returns:
- The number of nodes in the cluster.
-
withNumberOfNodes
public Snapshot withNumberOfNodes(Integer numberOfNodes)
The number of nodes in the cluster.
- Parameters:
numberOfNodes
- The number of nodes in the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
withDBName
public Snapshot withDBName(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setEncrypted
public void setEncrypted(Boolean encrypted)
If
true
, the data in the snapshot is encrypted at rest.- Parameters:
encrypted
- Iftrue
, the data in the snapshot is encrypted at rest.
-
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.
-
withEncrypted
public Snapshot withEncrypted(Boolean encrypted)
If
true
, the data in the snapshot is encrypted at rest.- Parameters:
encrypted
- Iftrue
, the data in the snapshot is encrypted at rest.- Returns:
- Returns a reference to this 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.
-
setKmsKeyId
public void setKmsKeyId(String kmsKeyId)
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
- Parameters:
kmsKeyId
- The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
-
getKmsKeyId
public String getKmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
- Returns:
- The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
-
withKmsKeyId
public Snapshot withKmsKeyId(String kmsKeyId)
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
- Parameters:
kmsKeyId
- The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEncryptedWithHSM
public void setEncryptedWithHSM(Boolean encryptedWithHSM)
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
true
indicates that the data is encrypted using HSM keys.- Parameters:
encryptedWithHSM
- A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.true
indicates that the data is encrypted using HSM keys.
-
getEncryptedWithHSM
public Boolean getEncryptedWithHSM()
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
true
indicates that the data is encrypted using HSM keys.- Returns:
- A boolean that indicates whether the snapshot data is encrypted
using the HSM keys of the source cluster.
true
indicates that the data is encrypted using HSM keys.
-
withEncryptedWithHSM
public Snapshot withEncryptedWithHSM(Boolean encryptedWithHSM)
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
true
indicates that the data is encrypted using HSM keys.- Parameters:
encryptedWithHSM
- A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.true
indicates that the data is encrypted using HSM keys.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEncryptedWithHSM
public Boolean isEncryptedWithHSM()
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
true
indicates that the data is encrypted using HSM keys.- Returns:
- A boolean that indicates whether the snapshot data is encrypted
using the HSM keys of the source cluster.
true
indicates that the data is encrypted using HSM keys.
-
getAccountsWithRestoreAccess
public List<AccountWithRestoreAccess> getAccountsWithRestoreAccess()
A list of the AWS customer accounts authorized to restore the snapshot. Returns
null
if no accounts are authorized. Visible only to the snapshot owner.- Returns:
- A list of the AWS customer accounts authorized to restore the
snapshot. Returns
null
if no accounts are authorized. Visible only to the snapshot owner.
-
setAccountsWithRestoreAccess
public void setAccountsWithRestoreAccess(Collection<AccountWithRestoreAccess> accountsWithRestoreAccess)
A list of the AWS customer accounts authorized to restore the snapshot. Returns
null
if no accounts are authorized. Visible only to the snapshot owner.- Parameters:
accountsWithRestoreAccess
- A list of the AWS customer accounts authorized to restore the snapshot. Returnsnull
if no accounts are authorized. Visible only to the snapshot owner.
-
withAccountsWithRestoreAccess
public Snapshot withAccountsWithRestoreAccess(AccountWithRestoreAccess... accountsWithRestoreAccess)
A list of the AWS customer accounts authorized to restore the snapshot. Returns
null
if no accounts are authorized. Visible only to the snapshot owner.NOTE: This method appends the values to the existing list (if any). Use
setAccountsWithRestoreAccess(java.util.Collection)
orwithAccountsWithRestoreAccess(java.util.Collection)
if you want to override the existing values.- Parameters:
accountsWithRestoreAccess
- A list of the AWS customer accounts authorized to restore the snapshot. Returnsnull
if no accounts are authorized. Visible only to the snapshot owner.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAccountsWithRestoreAccess
public Snapshot withAccountsWithRestoreAccess(Collection<AccountWithRestoreAccess> accountsWithRestoreAccess)
A list of the AWS customer accounts authorized to restore the snapshot. Returns
null
if no accounts are authorized. Visible only to the snapshot owner.- Parameters:
accountsWithRestoreAccess
- A list of the AWS customer accounts authorized to restore the snapshot. Returnsnull
if no accounts are authorized. Visible only to the snapshot owner.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOwnerAccount
public void setOwnerAccount(String ownerAccount)
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
- Parameters:
ownerAccount
- For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
-
getOwnerAccount
public String getOwnerAccount()
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
- Returns:
- For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
-
withOwnerAccount
public Snapshot withOwnerAccount(String ownerAccount)
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
- Parameters:
ownerAccount
- For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTotalBackupSizeInMegaBytes
public void setTotalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)
The size of the complete set of backup data that would be used to restore the cluster.
- Parameters:
totalBackupSizeInMegaBytes
- The size of the complete set of backup data that would be used to restore the cluster.
-
getTotalBackupSizeInMegaBytes
public Double getTotalBackupSizeInMegaBytes()
The size of the complete set of backup data that would be used to restore the cluster.
- Returns:
- The size of the complete set of backup data that would be used to restore the cluster.
-
withTotalBackupSizeInMegaBytes
public Snapshot withTotalBackupSizeInMegaBytes(Double totalBackupSizeInMegaBytes)
The size of the complete set of backup data that would be used to restore the cluster.
- Parameters:
totalBackupSizeInMegaBytes
- The size of the complete set of backup data that would be used to restore the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setActualIncrementalBackupSizeInMegaBytes
public void setActualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.
- Parameters:
actualIncrementalBackupSizeInMegaBytes
- The size of the incremental backup.
-
getActualIncrementalBackupSizeInMegaBytes
public Double getActualIncrementalBackupSizeInMegaBytes()
The size of the incremental backup.
- Returns:
- The size of the incremental backup.
-
withActualIncrementalBackupSizeInMegaBytes
public Snapshot withActualIncrementalBackupSizeInMegaBytes(Double actualIncrementalBackupSizeInMegaBytes)
The size of the incremental backup.
- Parameters:
actualIncrementalBackupSizeInMegaBytes
- The size of the incremental backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBackupProgressInMegaBytes
public void setBackupProgressInMegaBytes(Double backupProgressInMegaBytes)
The number of megabytes that have been transferred to the snapshot backup.
- Parameters:
backupProgressInMegaBytes
- The number of megabytes that have been transferred to the snapshot backup.
-
getBackupProgressInMegaBytes
public Double getBackupProgressInMegaBytes()
The number of megabytes that have been transferred to the snapshot backup.
- Returns:
- The number of megabytes that have been transferred to the snapshot backup.
-
withBackupProgressInMegaBytes
public Snapshot withBackupProgressInMegaBytes(Double backupProgressInMegaBytes)
The number of megabytes that have been transferred to the snapshot backup.
- Parameters:
backupProgressInMegaBytes
- The number of megabytes that have been transferred to the snapshot backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCurrentBackupRateInMegaBytesPerSecond
public void setCurrentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)
The number of megabytes per second being transferred to the snapshot backup. Returns
0
for a completed backup.- Parameters:
currentBackupRateInMegaBytesPerSecond
- The number of megabytes per second being transferred to the snapshot backup. Returns0
for a completed backup.
-
getCurrentBackupRateInMegaBytesPerSecond
public Double getCurrentBackupRateInMegaBytesPerSecond()
The number of megabytes per second being transferred to the snapshot backup. Returns
0
for a completed backup.- Returns:
- The number of megabytes per second being transferred to the
snapshot backup. Returns
0
for a completed backup.
-
withCurrentBackupRateInMegaBytesPerSecond
public Snapshot withCurrentBackupRateInMegaBytesPerSecond(Double currentBackupRateInMegaBytesPerSecond)
The number of megabytes per second being transferred to the snapshot backup. Returns
0
for a completed backup.- Parameters:
currentBackupRateInMegaBytesPerSecond
- The number of megabytes per second being transferred to the snapshot backup. Returns0
for a completed backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEstimatedSecondsToCompletion
public void setEstimatedSecondsToCompletion(Long estimatedSecondsToCompletion)
The estimate of the time remaining before the snapshot backup will complete. Returns
0
for a completed backup.- Parameters:
estimatedSecondsToCompletion
- The estimate of the time remaining before the snapshot backup will complete. Returns0
for a completed backup.
-
getEstimatedSecondsToCompletion
public Long getEstimatedSecondsToCompletion()
The estimate of the time remaining before the snapshot backup will complete. Returns
0
for a completed backup.- Returns:
- The estimate of the time remaining before the snapshot backup
will complete. Returns
0
for a completed backup.
-
withEstimatedSecondsToCompletion
public Snapshot withEstimatedSecondsToCompletion(Long estimatedSecondsToCompletion)
The estimate of the time remaining before the snapshot backup will complete. Returns
0
for a completed backup.- Parameters:
estimatedSecondsToCompletion
- The estimate of the time remaining before the snapshot backup will complete. Returns0
for a completed backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setElapsedTimeInSeconds
public void setElapsedTimeInSeconds(Long elapsedTimeInSeconds)
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
- Parameters:
elapsedTimeInSeconds
- The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
-
getElapsedTimeInSeconds
public Long getElapsedTimeInSeconds()
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
- Returns:
- The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
-
withElapsedTimeInSeconds
public Snapshot withElapsedTimeInSeconds(Long elapsedTimeInSeconds)
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
- Parameters:
elapsedTimeInSeconds
- The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSourceRegion
public void setSourceRegion(String sourceRegion)
The source region from which the snapshot was copied.
- Parameters:
sourceRegion
- The source region from which the snapshot was copied.
-
getSourceRegion
public String getSourceRegion()
The source region from which the snapshot was copied.
- Returns:
- The source region from which the snapshot was copied.
-
withSourceRegion
public Snapshot withSourceRegion(String sourceRegion)
The source region from which the snapshot was copied.
- Parameters:
sourceRegion
- The source region from which the snapshot was copied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
public List<Tag> getTags()
The list of tags for the cluster snapshot.
- Returns:
- The list of tags for the cluster snapshot.
-
setTags
public void setTags(Collection<Tag> tags)
The list of tags for the cluster snapshot.
- Parameters:
tags
- The list of tags for the cluster snapshot.
-
withTags
public Snapshot withTags(Tag... tags)
The list of tags for the cluster snapshot.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- The list of tags for the cluster snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public Snapshot withTags(Collection<Tag> tags)
The list of tags for the cluster snapshot.
- Parameters:
tags
- The list of tags for the cluster snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getRestorableNodeTypes
public List<String> getRestorableNodeTypes()
The list of node types that this cluster snapshot is able to restore into.
- Returns:
- The list of node types that this cluster snapshot is able to restore into.
-
setRestorableNodeTypes
public void setRestorableNodeTypes(Collection<String> restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
- Parameters:
restorableNodeTypes
- The list of node types that this cluster snapshot is able to restore into.
-
withRestorableNodeTypes
public Snapshot withRestorableNodeTypes(String... restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
NOTE: This method appends the values to the existing list (if any). Use
setRestorableNodeTypes(java.util.Collection)
orwithRestorableNodeTypes(java.util.Collection)
if you want to override the existing values.- Parameters:
restorableNodeTypes
- The list of node types that this cluster snapshot is able to restore into.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withRestorableNodeTypes
public Snapshot withRestorableNodeTypes(Collection<String> restorableNodeTypes)
The list of node types that this cluster snapshot is able to restore into.
- Parameters:
restorableNodeTypes
- The list of node types that this cluster snapshot is able to restore into.- 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()
-
-