com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2018-2023 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;
/**
*
* Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the
* UpdateTable operation.
*
*
* For current minimum and maximum provisioned throughput values, see Service, Account, and Table
* Quotas in the Amazon DynamoDB Developer Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ProvisionedThroughput implements Serializable, Cloneable, StructuredPojo {
/**
*
* The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying
* Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*
*/
private Long readCapacityUnits;
/**
*
* The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For
* more information, see Specifying
* Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*
*/
private Long writeCapacityUnits;
/**
* Default constructor for ProvisionedThroughput object. Callers should use the setter or fluent setter (with...)
* methods to initialize the object after creating it.
*/
public ProvisionedThroughput() {
}
/**
* Constructs a new ProvisionedThroughput object. Callers should use the setter or fluent setter (with...) methods
* to initialize any additional object members.
*
* @param readCapacityUnits
* The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
* @param writeCapacityUnits
* The maximum number of writes consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*/
public ProvisionedThroughput(Long readCapacityUnits, Long writeCapacityUnits) {
setReadCapacityUnits(readCapacityUnits);
setWriteCapacityUnits(writeCapacityUnits);
}
/**
*
* The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying
* Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*
*
* @param readCapacityUnits
* The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*/
public void setReadCapacityUnits(Long readCapacityUnits) {
this.readCapacityUnits = readCapacityUnits;
}
/**
*
* The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying
* Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*
*
* @return The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*/
public Long getReadCapacityUnits() {
return this.readCapacityUnits;
}
/**
*
* The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying
* Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*
*
* @param readCapacityUnits
* The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProvisionedThroughput withReadCapacityUnits(Long readCapacityUnits) {
setReadCapacityUnits(readCapacityUnits);
return this;
}
/**
*
* The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For
* more information, see Specifying
* Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*
*
* @param writeCapacityUnits
* The maximum number of writes consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*/
public void setWriteCapacityUnits(Long writeCapacityUnits) {
this.writeCapacityUnits = writeCapacityUnits;
}
/**
*
* The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For
* more information, see Specifying
* Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*
*
* @return The maximum number of writes consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*/
public Long getWriteCapacityUnits() {
return this.writeCapacityUnits;
}
/**
*
* The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For
* more information, see Specifying
* Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
*
*
* @param writeCapacityUnits
* The maximum number of writes consumed per second before DynamoDB returns a
* ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
*
* If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProvisionedThroughput withWriteCapacityUnits(Long writeCapacityUnits) {
setWriteCapacityUnits(writeCapacityUnits);
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 (getReadCapacityUnits() != null)
sb.append("ReadCapacityUnits: ").append(getReadCapacityUnits()).append(",");
if (getWriteCapacityUnits() != null)
sb.append("WriteCapacityUnits: ").append(getWriteCapacityUnits());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ProvisionedThroughput == false)
return false;
ProvisionedThroughput other = (ProvisionedThroughput) obj;
if (other.getReadCapacityUnits() == null ^ this.getReadCapacityUnits() == null)
return false;
if (other.getReadCapacityUnits() != null && other.getReadCapacityUnits().equals(this.getReadCapacityUnits()) == false)
return false;
if (other.getWriteCapacityUnits() == null ^ this.getWriteCapacityUnits() == null)
return false;
if (other.getWriteCapacityUnits() != null && other.getWriteCapacityUnits().equals(this.getWriteCapacityUnits()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getReadCapacityUnits() == null) ? 0 : getReadCapacityUnits().hashCode());
hashCode = prime * hashCode + ((getWriteCapacityUnits() == null) ? 0 : getWriteCapacityUnits().hashCode());
return hashCode;
}
@Override
public ProvisionedThroughput clone() {
try {
return (ProvisionedThroughput) 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.ProvisionedThroughputMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}