com.amazonaws.services.dynamodbv2.model.BackupSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains details for the backup.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BackupSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* Name of the table.
*
*/
private String tableName;
/**
*
* Unique identifier for the table.
*
*/
private String tableId;
/**
*
* ARN associated with the table.
*
*/
private String tableArn;
/**
*
* ARN associated with the backup.
*
*/
private String backupArn;
/**
*
* Name of the specified backup.
*
*/
private String backupName;
/**
*
* Time at which the backup was created.
*
*/
private java.util.Date backupCreationDateTime;
/**
*
* Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand
* backup expires automatically 35 days after its creation.
*
*/
private java.util.Date backupExpiryDateTime;
/**
*
* Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
*
*/
private String backupStatus;
/**
*
* BackupType:
*
*
* -
*
* USER - You create and manage these using the on-demand backup feature.
*
*
* -
*
* SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is
* automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore
* the deleted table to the state it was in just before the point of deletion.
*
*
* -
*
* AWS_BACKUP - On-demand backup created by you from Backup service.
*
*
*
*/
private String backupType;
/**
*
* Size of the backup in bytes.
*
*/
private Long backupSizeBytes;
/**
*
* Name of the table.
*
*
* @param tableName
* Name of the table.
*/
public void setTableName(String tableName) {
this.tableName = tableName;
}
/**
*
* Name of the table.
*
*
* @return Name of the table.
*/
public String getTableName() {
return this.tableName;
}
/**
*
* Name of the table.
*
*
* @param tableName
* Name of the table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BackupSummary withTableName(String tableName) {
setTableName(tableName);
return this;
}
/**
*
* Unique identifier for the table.
*
*
* @param tableId
* Unique identifier for the table.
*/
public void setTableId(String tableId) {
this.tableId = tableId;
}
/**
*
* Unique identifier for the table.
*
*
* @return Unique identifier for the table.
*/
public String getTableId() {
return this.tableId;
}
/**
*
* Unique identifier for the table.
*
*
* @param tableId
* Unique identifier for the table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BackupSummary withTableId(String tableId) {
setTableId(tableId);
return this;
}
/**
*
* ARN associated with the table.
*
*
* @param tableArn
* ARN associated with the table.
*/
public void setTableArn(String tableArn) {
this.tableArn = tableArn;
}
/**
*
* ARN associated with the table.
*
*
* @return ARN associated with the table.
*/
public String getTableArn() {
return this.tableArn;
}
/**
*
* ARN associated with the table.
*
*
* @param tableArn
* ARN associated with the table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BackupSummary withTableArn(String tableArn) {
setTableArn(tableArn);
return this;
}
/**
*
* ARN associated with the backup.
*
*
* @param backupArn
* ARN associated with the backup.
*/
public void setBackupArn(String backupArn) {
this.backupArn = backupArn;
}
/**
*
* ARN associated with the backup.
*
*
* @return ARN associated with the backup.
*/
public String getBackupArn() {
return this.backupArn;
}
/**
*
* ARN associated with the backup.
*
*
* @param backupArn
* ARN associated with the backup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BackupSummary withBackupArn(String backupArn) {
setBackupArn(backupArn);
return this;
}
/**
*
* Name of the specified backup.
*
*
* @param backupName
* Name of the specified backup.
*/
public void setBackupName(String backupName) {
this.backupName = backupName;
}
/**
*
* Name of the specified backup.
*
*
* @return Name of the specified backup.
*/
public String getBackupName() {
return this.backupName;
}
/**
*
* Name of the specified backup.
*
*
* @param backupName
* Name of the specified backup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BackupSummary withBackupName(String backupName) {
setBackupName(backupName);
return this;
}
/**
*
* Time at which the backup was created.
*
*
* @param backupCreationDateTime
* Time at which the backup was created.
*/
public void setBackupCreationDateTime(java.util.Date backupCreationDateTime) {
this.backupCreationDateTime = backupCreationDateTime;
}
/**
*
* Time at which the backup was created.
*
*
* @return Time at which the backup was created.
*/
public java.util.Date getBackupCreationDateTime() {
return this.backupCreationDateTime;
}
/**
*
* Time at which the backup was created.
*
*
* @param backupCreationDateTime
* Time at which the backup was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BackupSummary withBackupCreationDateTime(java.util.Date backupCreationDateTime) {
setBackupCreationDateTime(backupCreationDateTime);
return this;
}
/**
*
* Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand
* backup expires automatically 35 days after its creation.
*
*
* @param backupExpiryDateTime
* Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM
* on-demand backup expires automatically 35 days after its creation.
*/
public void setBackupExpiryDateTime(java.util.Date backupExpiryDateTime) {
this.backupExpiryDateTime = backupExpiryDateTime;
}
/**
*
* Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand
* backup expires automatically 35 days after its creation.
*
*
* @return Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM
* on-demand backup expires automatically 35 days after its creation.
*/
public java.util.Date getBackupExpiryDateTime() {
return this.backupExpiryDateTime;
}
/**
*
* Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand
* backup expires automatically 35 days after its creation.
*
*
* @param backupExpiryDateTime
* Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM
* on-demand backup expires automatically 35 days after its creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BackupSummary withBackupExpiryDateTime(java.util.Date backupExpiryDateTime) {
setBackupExpiryDateTime(backupExpiryDateTime);
return this;
}
/**
*
* Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
*
*
* @param backupStatus
* Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
* @see BackupStatus
*/
public void setBackupStatus(String backupStatus) {
this.backupStatus = backupStatus;
}
/**
*
* Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
*
*
* @return Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
* @see BackupStatus
*/
public String getBackupStatus() {
return this.backupStatus;
}
/**
*
* Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
*
*
* @param backupStatus
* Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupStatus
*/
public BackupSummary withBackupStatus(String backupStatus) {
setBackupStatus(backupStatus);
return this;
}
/**
*
* Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
*
*
* @param backupStatus
* Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupStatus
*/
public BackupSummary withBackupStatus(BackupStatus backupStatus) {
this.backupStatus = backupStatus.toString();
return this;
}
/**
*
* BackupType:
*
*
* -
*
* USER - You create and manage these using the on-demand backup feature.
*
*
* -
*
* SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is
* automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore
* the deleted table to the state it was in just before the point of deletion.
*
*
* -
*
* AWS_BACKUP - On-demand backup created by you from Backup service.
*
*
*
*
* @param backupType
* BackupType:
*
* -
*
* USER - You create and manage these using the on-demand backup feature.
*
*
* -
*
* SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM
* backup is automatically created and is retained for 35 days (at no additional cost). System backups allow
* you to restore the deleted table to the state it was in just before the point of deletion.
*
*
* -
*
* AWS_BACKUP - On-demand backup created by you from Backup service.
*
*
* @see BackupType
*/
public void setBackupType(String backupType) {
this.backupType = backupType;
}
/**
*
* BackupType:
*
*
* -
*
* USER - You create and manage these using the on-demand backup feature.
*
*
* -
*
* SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is
* automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore
* the deleted table to the state it was in just before the point of deletion.
*
*
* -
*
* AWS_BACKUP - On-demand backup created by you from Backup service.
*
*
*
*
* @return BackupType:
*
* -
*
* USER - You create and manage these using the on-demand backup feature.
*
*
* -
*
* SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM
* backup is automatically created and is retained for 35 days (at no additional cost). System backups allow
* you to restore the deleted table to the state it was in just before the point of deletion.
*
*
* -
*
* AWS_BACKUP - On-demand backup created by you from Backup service.
*
*
* @see BackupType
*/
public String getBackupType() {
return this.backupType;
}
/**
*
* BackupType:
*
*
* -
*
* USER - You create and manage these using the on-demand backup feature.
*
*
* -
*
* SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is
* automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore
* the deleted table to the state it was in just before the point of deletion.
*
*
* -
*
* AWS_BACKUP - On-demand backup created by you from Backup service.
*
*
*
*
* @param backupType
* BackupType:
*
* -
*
* USER - You create and manage these using the on-demand backup feature.
*
*
* -
*
* SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM
* backup is automatically created and is retained for 35 days (at no additional cost). System backups allow
* you to restore the deleted table to the state it was in just before the point of deletion.
*
*
* -
*
* AWS_BACKUP - On-demand backup created by you from Backup service.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupType
*/
public BackupSummary withBackupType(String backupType) {
setBackupType(backupType);
return this;
}
/**
*
* BackupType:
*
*
* -
*
* USER - You create and manage these using the on-demand backup feature.
*
*
* -
*
* SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is
* automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore
* the deleted table to the state it was in just before the point of deletion.
*
*
* -
*
* AWS_BACKUP - On-demand backup created by you from Backup service.
*
*
*
*
* @param backupType
* BackupType:
*
* -
*
* USER - You create and manage these using the on-demand backup feature.
*
*
* -
*
* SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM
* backup is automatically created and is retained for 35 days (at no additional cost). System backups allow
* you to restore the deleted table to the state it was in just before the point of deletion.
*
*
* -
*
* AWS_BACKUP - On-demand backup created by you from Backup service.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupType
*/
public BackupSummary withBackupType(BackupType backupType) {
this.backupType = backupType.toString();
return this;
}
/**
*
* Size of the backup in bytes.
*
*
* @param backupSizeBytes
* Size of the backup in bytes.
*/
public void setBackupSizeBytes(Long backupSizeBytes) {
this.backupSizeBytes = backupSizeBytes;
}
/**
*
* Size of the backup in bytes.
*
*
* @return Size of the backup in bytes.
*/
public Long getBackupSizeBytes() {
return this.backupSizeBytes;
}
/**
*
* Size of the backup in bytes.
*
*
* @param backupSizeBytes
* Size of the backup in bytes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BackupSummary withBackupSizeBytes(Long backupSizeBytes) {
setBackupSizeBytes(backupSizeBytes);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTableName() != null)
sb.append("TableName: ").append(getTableName()).append(",");
if (getTableId() != null)
sb.append("TableId: ").append(getTableId()).append(",");
if (getTableArn() != null)
sb.append("TableArn: ").append(getTableArn()).append(",");
if (getBackupArn() != null)
sb.append("BackupArn: ").append(getBackupArn()).append(",");
if (getBackupName() != null)
sb.append("BackupName: ").append(getBackupName()).append(",");
if (getBackupCreationDateTime() != null)
sb.append("BackupCreationDateTime: ").append(getBackupCreationDateTime()).append(",");
if (getBackupExpiryDateTime() != null)
sb.append("BackupExpiryDateTime: ").append(getBackupExpiryDateTime()).append(",");
if (getBackupStatus() != null)
sb.append("BackupStatus: ").append(getBackupStatus()).append(",");
if (getBackupType() != null)
sb.append("BackupType: ").append(getBackupType()).append(",");
if (getBackupSizeBytes() != null)
sb.append("BackupSizeBytes: ").append(getBackupSizeBytes());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BackupSummary == false)
return false;
BackupSummary other = (BackupSummary) obj;
if (other.getTableName() == null ^ this.getTableName() == null)
return false;
if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false)
return false;
if (other.getTableId() == null ^ this.getTableId() == null)
return false;
if (other.getTableId() != null && other.getTableId().equals(this.getTableId()) == false)
return false;
if (other.getTableArn() == null ^ this.getTableArn() == null)
return false;
if (other.getTableArn() != null && other.getTableArn().equals(this.getTableArn()) == false)
return false;
if (other.getBackupArn() == null ^ this.getBackupArn() == null)
return false;
if (other.getBackupArn() != null && other.getBackupArn().equals(this.getBackupArn()) == false)
return false;
if (other.getBackupName() == null ^ this.getBackupName() == null)
return false;
if (other.getBackupName() != null && other.getBackupName().equals(this.getBackupName()) == false)
return false;
if (other.getBackupCreationDateTime() == null ^ this.getBackupCreationDateTime() == null)
return false;
if (other.getBackupCreationDateTime() != null && other.getBackupCreationDateTime().equals(this.getBackupCreationDateTime()) == false)
return false;
if (other.getBackupExpiryDateTime() == null ^ this.getBackupExpiryDateTime() == null)
return false;
if (other.getBackupExpiryDateTime() != null && other.getBackupExpiryDateTime().equals(this.getBackupExpiryDateTime()) == false)
return false;
if (other.getBackupStatus() == null ^ this.getBackupStatus() == null)
return false;
if (other.getBackupStatus() != null && other.getBackupStatus().equals(this.getBackupStatus()) == false)
return false;
if (other.getBackupType() == null ^ this.getBackupType() == null)
return false;
if (other.getBackupType() != null && other.getBackupType().equals(this.getBackupType()) == false)
return false;
if (other.getBackupSizeBytes() == null ^ this.getBackupSizeBytes() == null)
return false;
if (other.getBackupSizeBytes() != null && other.getBackupSizeBytes().equals(this.getBackupSizeBytes()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode());
hashCode = prime * hashCode + ((getTableId() == null) ? 0 : getTableId().hashCode());
hashCode = prime * hashCode + ((getTableArn() == null) ? 0 : getTableArn().hashCode());
hashCode = prime * hashCode + ((getBackupArn() == null) ? 0 : getBackupArn().hashCode());
hashCode = prime * hashCode + ((getBackupName() == null) ? 0 : getBackupName().hashCode());
hashCode = prime * hashCode + ((getBackupCreationDateTime() == null) ? 0 : getBackupCreationDateTime().hashCode());
hashCode = prime * hashCode + ((getBackupExpiryDateTime() == null) ? 0 : getBackupExpiryDateTime().hashCode());
hashCode = prime * hashCode + ((getBackupStatus() == null) ? 0 : getBackupStatus().hashCode());
hashCode = prime * hashCode + ((getBackupType() == null) ? 0 : getBackupType().hashCode());
hashCode = prime * hashCode + ((getBackupSizeBytes() == null) ? 0 : getBackupSizeBytes().hashCode());
return hashCode;
}
@Override
public BackupSummary clone() {
try {
return (BackupSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.dynamodbv2.model.transform.BackupSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}