com.amazonaws.services.dynamodbv2.model.GlobalTableGlobalSecondaryIndexSettingsUpdate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-dynamodb Show documentation
The AWS Java SDK for Amazon DynamoDB module holds the client classes that are used for communicating with Amazon DynamoDB Service
The newest version!
/*
 * 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;

/**
 * 
 * Represents the settings of a global secondary index for a global table that will be modified.
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GlobalTableGlobalSecondaryIndexSettingsUpdate implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The name of the global secondary index. The name must be unique among all other indexes on this table.
     * 
     */
    private String indexName;
    /**
     * 
     * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
     * 
     */
    private Long provisionedWriteCapacityUnits;
    /**
     * 
     * Auto scaling settings for managing a global secondary index's write capacity units.
     * 
     */
    private AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingSettingsUpdate;

    /**
     * 
     * The name of the global secondary index. The name must be unique among all other indexes on this table.
     * 
     * 
     * @param indexName
     *        The name of the global secondary index. The name must be unique among all other indexes on this table.
     */

    public void setIndexName(String indexName) {
        this.indexName = indexName;
    }

    /**
     * 
     * The name of the global secondary index. The name must be unique among all other indexes on this table.
     * 
     * 
     * @return The name of the global secondary index. The name must be unique among all other indexes on this table.
     */

    public String getIndexName() {
        return this.indexName;
    }

    /**
     * 
     * The name of the global secondary index. The name must be unique among all other indexes on this table.
     * 
     * 
     * @param indexName
     *        The name of the global secondary index. The name must be unique among all other indexes on this table.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GlobalTableGlobalSecondaryIndexSettingsUpdate withIndexName(String indexName) {
        setIndexName(indexName);
        return this;
    }

    /**
     * 
     * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
     * 
     * 
     * @param provisionedWriteCapacityUnits
     *        The maximum number of writes consumed per second before DynamoDB returns a
     *        ThrottlingException.
     */

    public void setProvisionedWriteCapacityUnits(Long provisionedWriteCapacityUnits) {
        this.provisionedWriteCapacityUnits = provisionedWriteCapacityUnits;
    }

    /**
     * 
     * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
     * 
     * 
     * @return The maximum number of writes consumed per second before DynamoDB returns a
     *         ThrottlingException.
     */

    public Long getProvisionedWriteCapacityUnits() {
        return this.provisionedWriteCapacityUnits;
    }

    /**
     * 
     * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
     * 
     * 
     * @param provisionedWriteCapacityUnits
     *        The maximum number of writes consumed per second before DynamoDB returns a
     *        ThrottlingException.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GlobalTableGlobalSecondaryIndexSettingsUpdate withProvisionedWriteCapacityUnits(Long provisionedWriteCapacityUnits) {
        setProvisionedWriteCapacityUnits(provisionedWriteCapacityUnits);
        return this;
    }

    /**
     * 
     * Auto scaling settings for managing a global secondary index's write capacity units.
     * 
     * 
     * @param provisionedWriteCapacityAutoScalingSettingsUpdate
     *        Auto scaling settings for managing a global secondary index's write capacity units.
     */

    public void setProvisionedWriteCapacityAutoScalingSettingsUpdate(AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingSettingsUpdate) {
        this.provisionedWriteCapacityAutoScalingSettingsUpdate = provisionedWriteCapacityAutoScalingSettingsUpdate;
    }

    /**
     * 
     * Auto scaling settings for managing a global secondary index's write capacity units.
     * 
     * 
     * @return Auto scaling settings for managing a global secondary index's write capacity units.
     */

    public AutoScalingSettingsUpdate getProvisionedWriteCapacityAutoScalingSettingsUpdate() {
        return this.provisionedWriteCapacityAutoScalingSettingsUpdate;
    }

    /**
     * 
     * Auto scaling settings for managing a global secondary index's write capacity units.
     * 
     * 
     * @param provisionedWriteCapacityAutoScalingSettingsUpdate
     *        Auto scaling settings for managing a global secondary index's write capacity units.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GlobalTableGlobalSecondaryIndexSettingsUpdate withProvisionedWriteCapacityAutoScalingSettingsUpdate(
            AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingSettingsUpdate) {
        setProvisionedWriteCapacityAutoScalingSettingsUpdate(provisionedWriteCapacityAutoScalingSettingsUpdate);
        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 (getIndexName() != null)
            sb.append("IndexName: ").append(getIndexName()).append(",");
        if (getProvisionedWriteCapacityUnits() != null)
            sb.append("ProvisionedWriteCapacityUnits: ").append(getProvisionedWriteCapacityUnits()).append(",");
        if (getProvisionedWriteCapacityAutoScalingSettingsUpdate() != null)
            sb.append("ProvisionedWriteCapacityAutoScalingSettingsUpdate: ").append(getProvisionedWriteCapacityAutoScalingSettingsUpdate());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof GlobalTableGlobalSecondaryIndexSettingsUpdate == false)
            return false;
        GlobalTableGlobalSecondaryIndexSettingsUpdate other = (GlobalTableGlobalSecondaryIndexSettingsUpdate) obj;
        if (other.getIndexName() == null ^ this.getIndexName() == null)
            return false;
        if (other.getIndexName() != null && other.getIndexName().equals(this.getIndexName()) == false)
            return false;
        if (other.getProvisionedWriteCapacityUnits() == null ^ this.getProvisionedWriteCapacityUnits() == null)
            return false;
        if (other.getProvisionedWriteCapacityUnits() != null
                && other.getProvisionedWriteCapacityUnits().equals(this.getProvisionedWriteCapacityUnits()) == false)
            return false;
        if (other.getProvisionedWriteCapacityAutoScalingSettingsUpdate() == null ^ this.getProvisionedWriteCapacityAutoScalingSettingsUpdate() == null)
            return false;
        if (other.getProvisionedWriteCapacityAutoScalingSettingsUpdate() != null
                && other.getProvisionedWriteCapacityAutoScalingSettingsUpdate().equals(this.getProvisionedWriteCapacityAutoScalingSettingsUpdate()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getIndexName() == null) ? 0 : getIndexName().hashCode());
        hashCode = prime * hashCode + ((getProvisionedWriteCapacityUnits() == null) ? 0 : getProvisionedWriteCapacityUnits().hashCode());
        hashCode = prime * hashCode
                + ((getProvisionedWriteCapacityAutoScalingSettingsUpdate() == null) ? 0 : getProvisionedWriteCapacityAutoScalingSettingsUpdate().hashCode());
        return hashCode;
    }

    @Override
    public GlobalTableGlobalSecondaryIndexSettingsUpdate clone() {
        try {
            return (GlobalTableGlobalSecondaryIndexSettingsUpdate) 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.GlobalTableGlobalSecondaryIndexSettingsUpdateMarshaller.getInstance().marshall(this,
                protocolMarshaller);
    }
}