Java tutorial
/* * Copyright 2014-2019 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; /** * <p> * Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the * <code>UpdateTable</code> operation. * </p> * <p> * For current minimum and maximum provisioned throughput values, see <a * href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> in the <i>Amazon * DynamoDB Developer Guide</i>. * </p> * * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ProvisionedThroughput" target="_top">AWS API * Documentation</a> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ProvisionedThroughput implements Serializable, Cloneable, StructuredPojo { /** * <p> * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. * </p> */ private Long readCapacityUnits; /** * <p> * The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For * more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. * </p> */ 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 * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. * @param writeCapacityUnits * The maximum number of writes consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. */ public ProvisionedThroughput(Long readCapacityUnits, Long writeCapacityUnits) { setReadCapacityUnits(readCapacityUnits); setWriteCapacityUnits(writeCapacityUnits); } /** * <p> * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. * </p> * * @param readCapacityUnits * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. */ public void setReadCapacityUnits(Long readCapacityUnits) { this.readCapacityUnits = readCapacityUnits; } /** * <p> * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. * </p> * * @return The maximum number of strongly consistent reads consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. */ public Long getReadCapacityUnits() { return this.readCapacityUnits; } /** * <p> * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. * </p> * * @param readCapacityUnits * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> 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; } /** * <p> * The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For * more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. * </p> * * @param writeCapacityUnits * The maximum number of writes consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. */ public void setWriteCapacityUnits(Long writeCapacityUnits) { this.writeCapacityUnits = writeCapacityUnits; } /** * <p> * The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For * more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. * </p> * * @return The maximum number of writes consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. */ public Long getWriteCapacityUnits() { return this.writeCapacityUnits; } /** * <p> * The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For * more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. * </p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0. * </p> * * @param writeCapacityUnits * The maximum number of writes consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href= * "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput" * >Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> * <p> * If read/write capacity mode is <code>PAY_PER_REQUEST</code> 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); } }