com.amazonaws.services.dynamodbv2.model.ReplicaDescription Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2015-2020 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 the details of the replica.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ReplicaDescription implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the Region.
*
*/
private String regionName;
/**
*
* The current state of the replica:
*
*
* -
*
* CREATING - The replica is being created.
*
*
* -
*
* UPDATING - The replica is being updated.
*
*
* -
*
* DELETING - The replica is being deleted.
*
*
* -
*
* ACTIVE - The replica is ready for use.
*
*
* -
*
* REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
*
*
*
* If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the
* replication group. The replica will not be deleted and replication will stop from and to this region.
*
*
*
*/
private String replicaStatus;
/**
*
* Detailed information about the replica status.
*
*/
private String replicaStatusDescription;
/**
*
* Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
*
*/
private String replicaStatusPercentProgress;
/**
*
* The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
*
*/
private String kMSMasterKeyId;
/**
*
* Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput
* settings.
*
*/
private ProvisionedThroughputOverride provisionedThroughputOverride;
/**
*
* Replica-specific global secondary index settings.
*
*/
private java.util.List globalSecondaryIndexes;
/**
*
* The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the
* ReplicaStatus property.
*
*/
private java.util.Date replicaInaccessibleDateTime;
/**
*
* The name of the Region.
*
*
* @param regionName
* The name of the Region.
*/
public void setRegionName(String regionName) {
this.regionName = regionName;
}
/**
*
* The name of the Region.
*
*
* @return The name of the Region.
*/
public String getRegionName() {
return this.regionName;
}
/**
*
* The name of the Region.
*
*
* @param regionName
* The name of the Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReplicaDescription withRegionName(String regionName) {
setRegionName(regionName);
return this;
}
/**
*
* The current state of the replica:
*
*
* -
*
* CREATING - The replica is being created.
*
*
* -
*
* UPDATING - The replica is being updated.
*
*
* -
*
* DELETING - The replica is being deleted.
*
*
* -
*
* ACTIVE - The replica is ready for use.
*
*
* -
*
* REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
*
*
*
* If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the
* replication group. The replica will not be deleted and replication will stop from and to this region.
*
*
*
*
* @param replicaStatus
* The current state of the replica:
*
* -
*
* CREATING - The replica is being created.
*
*
* -
*
* UPDATING - The replica is being updated.
*
*
* -
*
* DELETING - The replica is being deleted.
*
*
* -
*
* ACTIVE - The replica is ready for use.
*
*
* -
*
* REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
*
*
*
* If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the
* replication group. The replica will not be deleted and replication will stop from and to this region.
*
*
* @see ReplicaStatus
*/
public void setReplicaStatus(String replicaStatus) {
this.replicaStatus = replicaStatus;
}
/**
*
* The current state of the replica:
*
*
* -
*
* CREATING - The replica is being created.
*
*
* -
*
* UPDATING - The replica is being updated.
*
*
* -
*
* DELETING - The replica is being deleted.
*
*
* -
*
* ACTIVE - The replica is ready for use.
*
*
* -
*
* REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
*
*
*
* If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the
* replication group. The replica will not be deleted and replication will stop from and to this region.
*
*
*
*
* @return The current state of the replica:
*
* -
*
* CREATING - The replica is being created.
*
*
* -
*
* UPDATING - The replica is being updated.
*
*
* -
*
* DELETING - The replica is being deleted.
*
*
* -
*
* ACTIVE - The replica is ready for use.
*
*
* -
*
* REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
*
*
*
* If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the
* replication group. The replica will not be deleted and replication will stop from and to this region.
*
*
* @see ReplicaStatus
*/
public String getReplicaStatus() {
return this.replicaStatus;
}
/**
*
* The current state of the replica:
*
*
* -
*
* CREATING - The replica is being created.
*
*
* -
*
* UPDATING - The replica is being updated.
*
*
* -
*
* DELETING - The replica is being deleted.
*
*
* -
*
* ACTIVE - The replica is ready for use.
*
*
* -
*
* REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
*
*
*
* If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the
* replication group. The replica will not be deleted and replication will stop from and to this region.
*
*
*
*
* @param replicaStatus
* The current state of the replica:
*
* -
*
* CREATING - The replica is being created.
*
*
* -
*
* UPDATING - The replica is being updated.
*
*
* -
*
* DELETING - The replica is being deleted.
*
*
* -
*
* ACTIVE - The replica is ready for use.
*
*
* -
*
* REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
*
*
*
* If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the
* replication group. The replica will not be deleted and replication will stop from and to this region.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicaStatus
*/
public ReplicaDescription withReplicaStatus(String replicaStatus) {
setReplicaStatus(replicaStatus);
return this;
}
/**
*
* The current state of the replica:
*
*
* -
*
* CREATING - The replica is being created.
*
*
* -
*
* UPDATING - The replica is being updated.
*
*
* -
*
* DELETING - The replica is being deleted.
*
*
* -
*
* ACTIVE - The replica is ready for use.
*
*
* -
*
* REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
*
*
*
* If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the
* replication group. The replica will not be deleted and replication will stop from and to this region.
*
*
*
*
* @param replicaStatus
* The current state of the replica:
*
* -
*
* CREATING - The replica is being created.
*
*
* -
*
* UPDATING - The replica is being updated.
*
*
* -
*
* DELETING - The replica is being deleted.
*
*
* -
*
* ACTIVE - The replica is ready for use.
*
*
* -
*
* REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.
*
*
*
* If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the
* replication group. The replica will not be deleted and replication will stop from and to this region.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReplicaStatus
*/
public ReplicaDescription withReplicaStatus(ReplicaStatus replicaStatus) {
this.replicaStatus = replicaStatus.toString();
return this;
}
/**
*
* Detailed information about the replica status.
*
*
* @param replicaStatusDescription
* Detailed information about the replica status.
*/
public void setReplicaStatusDescription(String replicaStatusDescription) {
this.replicaStatusDescription = replicaStatusDescription;
}
/**
*
* Detailed information about the replica status.
*
*
* @return Detailed information about the replica status.
*/
public String getReplicaStatusDescription() {
return this.replicaStatusDescription;
}
/**
*
* Detailed information about the replica status.
*
*
* @param replicaStatusDescription
* Detailed information about the replica status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReplicaDescription withReplicaStatusDescription(String replicaStatusDescription) {
setReplicaStatusDescription(replicaStatusDescription);
return this;
}
/**
*
* Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
*
*
* @param replicaStatusPercentProgress
* Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
*/
public void setReplicaStatusPercentProgress(String replicaStatusPercentProgress) {
this.replicaStatusPercentProgress = replicaStatusPercentProgress;
}
/**
*
* Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
*
*
* @return Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
*/
public String getReplicaStatusPercentProgress() {
return this.replicaStatusPercentProgress;
}
/**
*
* Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
*
*
* @param replicaStatusPercentProgress
* Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReplicaDescription withReplicaStatusPercentProgress(String replicaStatusPercentProgress) {
setReplicaStatusPercentProgress(replicaStatusPercentProgress);
return this;
}
/**
*
* The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
*
*
* @param kMSMasterKeyId
* The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
*/
public void setKMSMasterKeyId(String kMSMasterKeyId) {
this.kMSMasterKeyId = kMSMasterKeyId;
}
/**
*
* The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
*
*
* @return The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
*/
public String getKMSMasterKeyId() {
return this.kMSMasterKeyId;
}
/**
*
* The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
*
*
* @param kMSMasterKeyId
* The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReplicaDescription withKMSMasterKeyId(String kMSMasterKeyId) {
setKMSMasterKeyId(kMSMasterKeyId);
return this;
}
/**
*
* Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput
* settings.
*
*
* @param provisionedThroughputOverride
* Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput
* settings.
*/
public void setProvisionedThroughputOverride(ProvisionedThroughputOverride provisionedThroughputOverride) {
this.provisionedThroughputOverride = provisionedThroughputOverride;
}
/**
*
* Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput
* settings.
*
*
* @return Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput
* settings.
*/
public ProvisionedThroughputOverride getProvisionedThroughputOverride() {
return this.provisionedThroughputOverride;
}
/**
*
* Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput
* settings.
*
*
* @param provisionedThroughputOverride
* Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput
* settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReplicaDescription withProvisionedThroughputOverride(ProvisionedThroughputOverride provisionedThroughputOverride) {
setProvisionedThroughputOverride(provisionedThroughputOverride);
return this;
}
/**
*
* Replica-specific global secondary index settings.
*
*
* @return Replica-specific global secondary index settings.
*/
public java.util.List getGlobalSecondaryIndexes() {
return globalSecondaryIndexes;
}
/**
*
* Replica-specific global secondary index settings.
*
*
* @param globalSecondaryIndexes
* Replica-specific global secondary index settings.
*/
public void setGlobalSecondaryIndexes(java.util.Collection globalSecondaryIndexes) {
if (globalSecondaryIndexes == null) {
this.globalSecondaryIndexes = null;
return;
}
this.globalSecondaryIndexes = new java.util.ArrayList(globalSecondaryIndexes);
}
/**
*
* Replica-specific global secondary index settings.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setGlobalSecondaryIndexes(java.util.Collection)} or
* {@link #withGlobalSecondaryIndexes(java.util.Collection)} if you want to override the existing values.
*
*
* @param globalSecondaryIndexes
* Replica-specific global secondary index settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReplicaDescription withGlobalSecondaryIndexes(ReplicaGlobalSecondaryIndexDescription... globalSecondaryIndexes) {
if (this.globalSecondaryIndexes == null) {
setGlobalSecondaryIndexes(new java.util.ArrayList(globalSecondaryIndexes.length));
}
for (ReplicaGlobalSecondaryIndexDescription ele : globalSecondaryIndexes) {
this.globalSecondaryIndexes.add(ele);
}
return this;
}
/**
*
* Replica-specific global secondary index settings.
*
*
* @param globalSecondaryIndexes
* Replica-specific global secondary index settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReplicaDescription withGlobalSecondaryIndexes(java.util.Collection globalSecondaryIndexes) {
setGlobalSecondaryIndexes(globalSecondaryIndexes);
return this;
}
/**
*
* The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the
* ReplicaStatus property.
*
*
* @param replicaInaccessibleDateTime
* The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility
* check the ReplicaStatus property.
*/
public void setReplicaInaccessibleDateTime(java.util.Date replicaInaccessibleDateTime) {
this.replicaInaccessibleDateTime = replicaInaccessibleDateTime;
}
/**
*
* The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the
* ReplicaStatus property.
*
*
* @return The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility
* check the ReplicaStatus property.
*/
public java.util.Date getReplicaInaccessibleDateTime() {
return this.replicaInaccessibleDateTime;
}
/**
*
* The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the
* ReplicaStatus property.
*
*
* @param replicaInaccessibleDateTime
* The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility
* check the ReplicaStatus property.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ReplicaDescription withReplicaInaccessibleDateTime(java.util.Date replicaInaccessibleDateTime) {
setReplicaInaccessibleDateTime(replicaInaccessibleDateTime);
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 (getRegionName() != null)
sb.append("RegionName: ").append(getRegionName()).append(",");
if (getReplicaStatus() != null)
sb.append("ReplicaStatus: ").append(getReplicaStatus()).append(",");
if (getReplicaStatusDescription() != null)
sb.append("ReplicaStatusDescription: ").append(getReplicaStatusDescription()).append(",");
if (getReplicaStatusPercentProgress() != null)
sb.append("ReplicaStatusPercentProgress: ").append(getReplicaStatusPercentProgress()).append(",");
if (getKMSMasterKeyId() != null)
sb.append("KMSMasterKeyId: ").append(getKMSMasterKeyId()).append(",");
if (getProvisionedThroughputOverride() != null)
sb.append("ProvisionedThroughputOverride: ").append(getProvisionedThroughputOverride()).append(",");
if (getGlobalSecondaryIndexes() != null)
sb.append("GlobalSecondaryIndexes: ").append(getGlobalSecondaryIndexes()).append(",");
if (getReplicaInaccessibleDateTime() != null)
sb.append("ReplicaInaccessibleDateTime: ").append(getReplicaInaccessibleDateTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ReplicaDescription == false)
return false;
ReplicaDescription other = (ReplicaDescription) obj;
if (other.getRegionName() == null ^ this.getRegionName() == null)
return false;
if (other.getRegionName() != null && other.getRegionName().equals(this.getRegionName()) == false)
return false;
if (other.getReplicaStatus() == null ^ this.getReplicaStatus() == null)
return false;
if (other.getReplicaStatus() != null && other.getReplicaStatus().equals(this.getReplicaStatus()) == false)
return false;
if (other.getReplicaStatusDescription() == null ^ this.getReplicaStatusDescription() == null)
return false;
if (other.getReplicaStatusDescription() != null && other.getReplicaStatusDescription().equals(this.getReplicaStatusDescription()) == false)
return false;
if (other.getReplicaStatusPercentProgress() == null ^ this.getReplicaStatusPercentProgress() == null)
return false;
if (other.getReplicaStatusPercentProgress() != null && other.getReplicaStatusPercentProgress().equals(this.getReplicaStatusPercentProgress()) == false)
return false;
if (other.getKMSMasterKeyId() == null ^ this.getKMSMasterKeyId() == null)
return false;
if (other.getKMSMasterKeyId() != null && other.getKMSMasterKeyId().equals(this.getKMSMasterKeyId()) == false)
return false;
if (other.getProvisionedThroughputOverride() == null ^ this.getProvisionedThroughputOverride() == null)
return false;
if (other.getProvisionedThroughputOverride() != null
&& other.getProvisionedThroughputOverride().equals(this.getProvisionedThroughputOverride()) == false)
return false;
if (other.getGlobalSecondaryIndexes() == null ^ this.getGlobalSecondaryIndexes() == null)
return false;
if (other.getGlobalSecondaryIndexes() != null && other.getGlobalSecondaryIndexes().equals(this.getGlobalSecondaryIndexes()) == false)
return false;
if (other.getReplicaInaccessibleDateTime() == null ^ this.getReplicaInaccessibleDateTime() == null)
return false;
if (other.getReplicaInaccessibleDateTime() != null && other.getReplicaInaccessibleDateTime().equals(this.getReplicaInaccessibleDateTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRegionName() == null) ? 0 : getRegionName().hashCode());
hashCode = prime * hashCode + ((getReplicaStatus() == null) ? 0 : getReplicaStatus().hashCode());
hashCode = prime * hashCode + ((getReplicaStatusDescription() == null) ? 0 : getReplicaStatusDescription().hashCode());
hashCode = prime * hashCode + ((getReplicaStatusPercentProgress() == null) ? 0 : getReplicaStatusPercentProgress().hashCode());
hashCode = prime * hashCode + ((getKMSMasterKeyId() == null) ? 0 : getKMSMasterKeyId().hashCode());
hashCode = prime * hashCode + ((getProvisionedThroughputOverride() == null) ? 0 : getProvisionedThroughputOverride().hashCode());
hashCode = prime * hashCode + ((getGlobalSecondaryIndexes() == null) ? 0 : getGlobalSecondaryIndexes().hashCode());
hashCode = prime * hashCode + ((getReplicaInaccessibleDateTime() == null) ? 0 : getReplicaInaccessibleDateTime().hashCode());
return hashCode;
}
@Override
public ReplicaDescription clone() {
try {
return (ReplicaDescription) 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.ReplicaDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}