/* * 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 GlobalSecondaryIndexDescription implements Serializable, Cloneable, StructuredPojo { /** ** The name of the global secondary index. *
*/ 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: *
*
* 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. *
** 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; /** ** The current state of the global secondary index: *
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the
* table and determining whether they can be added to the index. (Not all items will qualify: For example, a
* partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After
* all items have been processed, the backfilling operation is complete and Backfilling
is false.
*
* You can delete an index that is being created during the Backfilling
phase when
* IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
* is being created when IndexStatus
is set to CREATING and Backfilling
is false.
*
* For indexes that were created during a CreateTable
operation, the Backfilling
attribute
* does not appear in the DescribeTable
output.
*
* 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 ProvisionedThroughputDescription provisionedThroughput; /** ** The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. * Recent changes might not be reflected in this value. *
*/ private Long indexSizeBytes; /** ** The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent * changes might not be reflected in this value. *
*/ private Long itemCount; /** ** The Amazon Resource Name (ARN) that uniquely identifies the index. *
*/ private String indexArn; /** ** The name of the global secondary index. *
* * @param indexName * The name of the global secondary index. */ public void setIndexName(String indexName) { this.indexName = indexName; } /** ** The name of the global secondary index. *
* * @return The name of the global secondary index. */ public String getIndexName() { return this.indexName; } /** ** The name of the global secondary index. *
* * @param indexName * The name of the global secondary index. * @return Returns a reference to this object so that method calls can be chained together. */ public GlobalSecondaryIndexDescription 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: *
*
* 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. *
*
* 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 java.util.List* 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. *
*
* 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* 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 GlobalSecondaryIndexDescription withKeySchema(KeySchemaElement... keySchema) { if (this.keySchema == null) { setKeySchema(new java.util.ArrayList* 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. *
*
* 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 GlobalSecondaryIndexDescription withKeySchema(java.util.Collection* 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 GlobalSecondaryIndexDescription withProjection(Projection projection) { setProjection(projection); return this; } /** ** The current state of the global secondary index: *
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* The current state of the global secondary index: *
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* The current state of the global secondary index: *
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* The current state of the global secondary index: *
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* The current state of the global secondary index: *
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* CREATING
- The index is being created.
*
* UPDATING
- The index is being updated.
*
* DELETING
- The index is being deleted.
*
* ACTIVE
- The index is ready for use.
*
* Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the
* table and determining whether they can be added to the index. (Not all items will qualify: For example, a
* partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After
* all items have been processed, the backfilling operation is complete and Backfilling
is false.
*
* You can delete an index that is being created during the Backfilling
phase when
* IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
* is being created when IndexStatus
is set to CREATING and Backfilling
is false.
*
* For indexes that were created during a CreateTable
operation, the Backfilling
attribute
* does not appear in the DescribeTable
output.
*
Backfilling
is false.
*
* You can delete an index that is being created during the Backfilling
phase when
* IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
* index that is being created when IndexStatus
is set to CREATING and Backfilling
* is false.
*
* For indexes that were created during a CreateTable
operation, the Backfilling
* attribute does not appear in the DescribeTable
output.
*
* Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the
* table and determining whether they can be added to the index. (Not all items will qualify: For example, a
* partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After
* all items have been processed, the backfilling operation is complete and Backfilling
is false.
*
* You can delete an index that is being created during the Backfilling
phase when
* IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
* is being created when IndexStatus
is set to CREATING and Backfilling
is false.
*
* For indexes that were created during a CreateTable
operation, the Backfilling
attribute
* does not appear in the DescribeTable
output.
*
Backfilling
is false.
*
* You can delete an index that is being created during the Backfilling
phase when
* IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
* index that is being created when IndexStatus
is set to CREATING and Backfilling
* is false.
*
* For indexes that were created during a CreateTable
operation, the Backfilling
* attribute does not appear in the DescribeTable
output.
*
* Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the
* table and determining whether they can be added to the index. (Not all items will qualify: For example, a
* partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After
* all items have been processed, the backfilling operation is complete and Backfilling
is false.
*
* You can delete an index that is being created during the Backfilling
phase when
* IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
* is being created when IndexStatus
is set to CREATING and Backfilling
is false.
*
* For indexes that were created during a CreateTable
operation, the Backfilling
attribute
* does not appear in the DescribeTable
output.
*
Backfilling
is false.
*
* You can delete an index that is being created during the Backfilling
phase when
* IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
* index that is being created when IndexStatus
is set to CREATING and Backfilling
* is false.
*
* For indexes that were created during a CreateTable
operation, the Backfilling
* attribute does not appear in the DescribeTable
output.
*
* Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the
* table and determining whether they can be added to the index. (Not all items will qualify: For example, a
* partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After
* all items have been processed, the backfilling operation is complete and Backfilling
is false.
*
* You can delete an index that is being created during the Backfilling
phase when
* IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the index that
* is being created when IndexStatus
is set to CREATING and Backfilling
is false.
*
* For indexes that were created during a CreateTable
operation, the Backfilling
attribute
* does not appear in the DescribeTable
output.
*
Backfilling
is false.
*
* You can delete an index that is being created during the Backfilling
phase when
* IndexStatus
is set to CREATING and Backfilling
is true. You can't delete the
* index that is being created when IndexStatus
is set to CREATING and Backfilling
* is false.
*
* For indexes that were created during a CreateTable
operation, the Backfilling
* attribute does not appear in the DescribeTable
output.
*
* 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(ProvisionedThroughputDescription 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 ProvisionedThroughputDescription 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 GlobalSecondaryIndexDescription withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput) { setProvisionedThroughput(provisionedThroughput); return this; } /** *
* The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. * Recent changes might not be reflected in this value. *
* * @param indexSizeBytes * The total size of the specified index, in bytes. DynamoDB updates this value approximately every six * hours. Recent changes might not be reflected in this value. */ public void setIndexSizeBytes(Long indexSizeBytes) { this.indexSizeBytes = indexSizeBytes; } /** ** The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. * Recent changes might not be reflected in this value. *
* * @return The total size of the specified index, in bytes. DynamoDB updates this value approximately every six * hours. Recent changes might not be reflected in this value. */ public Long getIndexSizeBytes() { return this.indexSizeBytes; } /** ** The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. * Recent changes might not be reflected in this value. *
* * @param indexSizeBytes * The total size of the specified index, in bytes. DynamoDB updates this value approximately every six * hours. Recent changes might not be reflected in this value. * @return Returns a reference to this object so that method calls can be chained together. */ public GlobalSecondaryIndexDescription withIndexSizeBytes(Long indexSizeBytes) { setIndexSizeBytes(indexSizeBytes); return this; } /** ** The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent * changes might not be reflected in this value. *
* * @param itemCount * The number of items in the specified index. DynamoDB updates this value approximately every six hours. * Recent changes might not be reflected in this value. */ public void setItemCount(Long itemCount) { this.itemCount = itemCount; } /** ** The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent * changes might not be reflected in this value. *
* * @return The number of items in the specified index. DynamoDB updates this value approximately every six hours. * Recent changes might not be reflected in this value. */ public Long getItemCount() { return this.itemCount; } /** ** The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent * changes might not be reflected in this value. *
* * @param itemCount * The number of items in the specified index. DynamoDB updates this value approximately every six hours. * Recent changes might not be reflected in this value. * @return Returns a reference to this object so that method calls can be chained together. */ public GlobalSecondaryIndexDescription withItemCount(Long itemCount) { setItemCount(itemCount); return this; } /** ** The Amazon Resource Name (ARN) that uniquely identifies the index. *
* * @param indexArn * The Amazon Resource Name (ARN) that uniquely identifies the index. */ public void setIndexArn(String indexArn) { this.indexArn = indexArn; } /** ** The Amazon Resource Name (ARN) that uniquely identifies the index. *
* * @return The Amazon Resource Name (ARN) that uniquely identifies the index. */ public String getIndexArn() { return this.indexArn; } /** ** The Amazon Resource Name (ARN) that uniquely identifies the index. *
* * @param indexArn * The Amazon Resource Name (ARN) that uniquely identifies the index. * @return Returns a reference to this object so that method calls can be chained together. */ public GlobalSecondaryIndexDescription withIndexArn(String indexArn) { setIndexArn(indexArn); 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 (getIndexStatus() != null) sb.append("IndexStatus: ").append(getIndexStatus()).append(","); if (getBackfilling() != null) sb.append("Backfilling: ").append(getBackfilling()).append(","); if (getProvisionedThroughput() != null) sb.append("ProvisionedThroughput: ").append(getProvisionedThroughput()).append(","); if (getIndexSizeBytes() != null) sb.append("IndexSizeBytes: ").append(getIndexSizeBytes()).append(","); if (getItemCount() != null) sb.append("ItemCount: ").append(getItemCount()).append(","); if (getIndexArn() != null) sb.append("IndexArn: ").append(getIndexArn()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GlobalSecondaryIndexDescription == false) return false; GlobalSecondaryIndexDescription other = (GlobalSecondaryIndexDescription) 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.getIndexStatus() == null ^ this.getIndexStatus() == null) return false; if (other.getIndexStatus() != null && other.getIndexStatus().equals(this.getIndexStatus()) == false) return false; if (other.getBackfilling() == null ^ this.getBackfilling() == null) return false; if (other.getBackfilling() != null && other.getBackfilling().equals(this.getBackfilling()) == false) return false; if (other.getProvisionedThroughput() == null ^ this.getProvisionedThroughput() == null) return false; if (other.getProvisionedThroughput() != null && other.getProvisionedThroughput().equals(this.getProvisionedThroughput()) == false) return false; if (other.getIndexSizeBytes() == null ^ this.getIndexSizeBytes() == null) return false; if (other.getIndexSizeBytes() != null && other.getIndexSizeBytes().equals(this.getIndexSizeBytes()) == false) return false; if (other.getItemCount() == null ^ this.getItemCount() == null) return false; if (other.getItemCount() != null && other.getItemCount().equals(this.getItemCount()) == false) return false; if (other.getIndexArn() == null ^ this.getIndexArn() == null) return false; if (other.getIndexArn() != null && other.getIndexArn().equals(this.getIndexArn()) == 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 + ((getIndexStatus() == null) ? 0 : getIndexStatus().hashCode()); hashCode = prime * hashCode + ((getBackfilling() == null) ? 0 : getBackfilling().hashCode()); hashCode = prime * hashCode + ((getProvisionedThroughput() == null) ? 0 : getProvisionedThroughput().hashCode()); hashCode = prime * hashCode + ((getIndexSizeBytes() == null) ? 0 : getIndexSizeBytes().hashCode()); hashCode = prime * hashCode + ((getItemCount() == null) ? 0 : getItemCount().hashCode()); hashCode = prime * hashCode + ((getIndexArn() == null) ? 0 : getIndexArn().hashCode()); return hashCode; } @Override public GlobalSecondaryIndexDescription clone() { try { return (GlobalSecondaryIndexDescription) 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.GlobalSecondaryIndexDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller); } }