/* * 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 properties of a global secondary index. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GlobalSecondaryIndex 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 complete key schema for a global secondary index, which consists of one or more pairs of attribute names and * key types: *

* * *

* The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from * DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their * partition key values. *

*

* The sort key of an item is also known as its range attribute. The term "range attribute" derives from the * way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key * value. *

* */ private java.util.List keySchema; /** *

* Represents attributes that are copied (projected) from the table into the global secondary index. These are in * addition to the primary key attributes and index key attributes, which are automatically projected. *

*/ private Projection projection; /** *

* Represents the provisioned throughput settings for the specified global secondary index. *

*

* For current minimum and maximum provisioned throughput values, see Service, Account, and Table * Quotas in the Amazon DynamoDB Developer Guide. *

*/ private ProvisionedThroughput provisionedThroughput; /** *

* 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 GlobalSecondaryIndex withIndexName(String indexName) { setIndexName(indexName); return this; } /** *

* The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and * key types: *

* * *

* The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from * DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their * partition key values. *

*

* The sort key of an item is also known as its range attribute. The term "range attribute" derives from the * way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key * value. *

* * * @return The complete key schema for a global secondary index, which consists of one or more pairs of attribute * names and key types:

* * *

* The partition key of an item is also known as its hash attribute. The term "hash attribute" * derives from DynamoDB's usage of an internal hash function to evenly distribute data items across * partitions, based on their partition key values. *

*

* The sort key of an item is also known as its range attribute. The term "range attribute" derives * from the way DynamoDB stores items with the same partition key physically close together, in sorted order * by the sort key value. *

*/ public java.util.List getKeySchema() { return keySchema; } /** *

* The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and * key types: *

*
    *
  • *

    * HASH - partition key *

    *
    • *
  • *

    * RANGE - sort key *

    *
    • *
* *

* The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from * DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their * partition key values. *

*

* The sort key of an item is also known as its range attribute. The term "range attribute" derives from the * way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key * value. *

* * * @param keySchema * The complete key schema for a global secondary index, which consists of one or more pairs of attribute * names and key types:

*
    *
  • *

    * HASH - partition key *

    *
    • *
  • *

    * RANGE - sort key *

    *
    • *
* *

* The partition key of an item is also known as its hash attribute. The term "hash attribute" derives * from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, * based on their partition key values. *

*

* The sort key of an item is also known as its range attribute. The term "range attribute" derives * from the way DynamoDB stores items with the same partition key physically close together, in sorted order * by the sort key value. *

*/ public void setKeySchema(java.util.Collection keySchema) { if (keySchema == null) { this.keySchema = null; return; } this.keySchema = new java.util.ArrayList(keySchema); } /** *

* The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and * key types: *

*
    *
  • *

    * HASH - partition key *

    *
    • *
  • *

    * RANGE - sort key *

    *
    • *
* *

* The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from * DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their * partition key values. *

*

* The sort key of an item is also known as its range attribute. The term "range attribute" derives from the * way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key * value. *

* *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setKeySchema(java.util.Collection)} or {@link #withKeySchema(java.util.Collection)} if you want to * override the existing values. *

* * @param keySchema * The complete key schema for a global secondary index, which consists of one or more pairs of attribute * names and key types:

*
    *
  • *

    * HASH - partition key *

    *
    • *
  • *

    * RANGE - sort key *

    *
    • *
* *

* The partition key of an item is also known as its hash attribute. The term "hash attribute" derives * from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, * based on their partition key values. *

*

* The sort key of an item is also known as its range attribute. The term "range attribute" derives * from the way DynamoDB stores items with the same partition key physically close together, in sorted order * by the sort key value. *

* @return Returns a reference to this object so that method calls can be chained together. */ public GlobalSecondaryIndex withKeySchema(KeySchemaElement... keySchema) { if (this.keySchema == null) { setKeySchema(new java.util.ArrayList(keySchema.length)); } for (KeySchemaElement ele : keySchema) { this.keySchema.add(ele); } return this; } /** *

* The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and * key types: *

*
    *
  • *

    * HASH - partition key *

    *
    • *
  • *

    * RANGE - sort key *

    *
    • *
* *

* The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from * DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their * partition key values. *

*

* The sort key of an item is also known as its range attribute. The term "range attribute" derives from the * way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key * value. *

* * * @param keySchema * The complete key schema for a global secondary index, which consists of one or more pairs of attribute * names and key types:

*
    *
  • *

    * HASH - partition key *

    *
    • *
  • *

    * RANGE - sort key *

    *
    • *
* *

* The partition key of an item is also known as its hash attribute. The term "hash attribute" derives * from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, * based on their partition key values. *

*

* The sort key of an item is also known as its range attribute. The term "range attribute" derives * from the way DynamoDB stores items with the same partition key physically close together, in sorted order * by the sort key value. *

* @return Returns a reference to this object so that method calls can be chained together. */ public GlobalSecondaryIndex withKeySchema(java.util.Collection keySchema) { setKeySchema(keySchema); return this; } /** *

* Represents attributes that are copied (projected) from the table into the global secondary index. These are in * addition to the primary key attributes and index key attributes, which are automatically projected. *

* * @param projection * Represents attributes that are copied (projected) from the table into the global secondary index. These * are in addition to the primary key attributes and index key attributes, which are automatically projected. */ public void setProjection(Projection projection) { this.projection = projection; } /** *

* Represents attributes that are copied (projected) from the table into the global secondary index. These are in * addition to the primary key attributes and index key attributes, which are automatically projected. *

* * @return Represents attributes that are copied (projected) from the table into the global secondary index. These * are in addition to the primary key attributes and index key attributes, which are automatically * projected. */ public Projection getProjection() { return this.projection; } /** *

* Represents attributes that are copied (projected) from the table into the global secondary index. These are in * addition to the primary key attributes and index key attributes, which are automatically projected. *

* * @param projection * Represents attributes that are copied (projected) from the table into the global secondary index. These * are in addition to the primary key attributes and index key attributes, which are automatically projected. * @return Returns a reference to this object so that method calls can be chained together. */ public GlobalSecondaryIndex withProjection(Projection projection) { setProjection(projection); return this; } /** *

* Represents the provisioned throughput settings for the specified global secondary index. *

*

* For current minimum and maximum provisioned throughput values, see Service, Account, and Table * Quotas in the Amazon DynamoDB Developer Guide. *

* * @param provisionedThroughput * Represents the provisioned throughput settings for the specified global secondary index.

*

* For current minimum and maximum provisioned throughput values, see Service, Account, and * Table Quotas in the Amazon DynamoDB Developer Guide. */ public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput) { this.provisionedThroughput = provisionedThroughput; } /** *

* Represents the provisioned throughput settings for the specified global secondary index. *

*

* For current minimum and maximum provisioned throughput values, see Service, Account, and Table * Quotas in the Amazon DynamoDB Developer Guide. *

* * @return Represents the provisioned throughput settings for the specified global secondary index.

*

* For current minimum and maximum provisioned throughput values, see Service, Account, and * Table Quotas in the Amazon DynamoDB Developer Guide. */ public ProvisionedThroughput getProvisionedThroughput() { return this.provisionedThroughput; } /** *

* Represents the provisioned throughput settings for the specified global secondary index. *

*

* For current minimum and maximum provisioned throughput values, see Service, Account, and Table * Quotas in the Amazon DynamoDB Developer Guide. *

* * @param provisionedThroughput * Represents the provisioned throughput settings for the specified global secondary index.

*

* For current minimum and maximum provisioned throughput values, see Service, Account, and * Table Quotas in the Amazon DynamoDB Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public GlobalSecondaryIndex withProvisionedThroughput(ProvisionedThroughput provisionedThroughput) { setProvisionedThroughput(provisionedThroughput); 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 (getKeySchema() != null) sb.append("KeySchema: ").append(getKeySchema()).append(","); if (getProjection() != null) sb.append("Projection: ").append(getProjection()).append(","); if (getProvisionedThroughput() != null) sb.append("ProvisionedThroughput: ").append(getProvisionedThroughput()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GlobalSecondaryIndex == false) return false; GlobalSecondaryIndex other = (GlobalSecondaryIndex) obj; if (other.getIndexName() == null ^ this.getIndexName() == null) return false; if (other.getIndexName() != null && other.getIndexName().equals(this.getIndexName()) == false) return false; if (other.getKeySchema() == null ^ this.getKeySchema() == null) return false; if (other.getKeySchema() != null && other.getKeySchema().equals(this.getKeySchema()) == false) return false; if (other.getProjection() == null ^ this.getProjection() == null) return false; if (other.getProjection() != null && other.getProjection().equals(this.getProjection()) == false) return false; if (other.getProvisionedThroughput() == null ^ this.getProvisionedThroughput() == null) return false; if (other.getProvisionedThroughput() != null && other.getProvisionedThroughput().equals(this.getProvisionedThroughput()) == 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 + ((getKeySchema() == null) ? 0 : getKeySchema().hashCode()); hashCode = prime * hashCode + ((getProjection() == null) ? 0 : getProjection().hashCode()); hashCode = prime * hashCode + ((getProvisionedThroughput() == null) ? 0 : getProvisionedThroughput().hashCode()); return hashCode; } @Override public GlobalSecondaryIndex clone() { try { return (GlobalSecondaryIndex) 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.GlobalSecondaryIndexMarshaller.getInstance().marshall(this, protocolMarshaller); } }