/* * Copyright 2010-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; /** *
* Represents the properties of a global secondary index for the table when the * backup was created. *
*/ public class GlobalSecondaryIndexInfo implements Serializable { /** ** The name of the global secondary index. *
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*/
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' 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; /** ** Represents the provisioned throughput settings for the specified global * secondary index. *
*/ private ProvisionedThroughput provisionedThroughput; /** ** The name of the global secondary index. *
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @return
* The name of the global secondary index. *
*/ public String getIndexName() { return indexName; } /** ** The name of the global secondary index. *
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @param indexName
* The name of the global secondary index. *
*/ public void setIndexName(String indexName) { this.indexName = indexName; } /** ** The name of the global secondary index. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @param indexName
* The name of the global secondary index. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GlobalSecondaryIndexInfo withIndexName(String indexName) { this.indexName = 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' 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. *
** 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' * 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. *
** 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' 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. *
** 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' 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. *
** 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' 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @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' 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. *
** 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' 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @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' 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. *
* * @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 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. *
*/ 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @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 A reference to this updated object so that method calls can be * chained together. */ public GlobalSecondaryIndexInfo withProjection(Projection projection) { this.projection = projection; return this; } /** ** Represents the provisioned throughput settings for the specified global * secondary index. *
* * @return* Represents the provisioned throughput settings for the specified * global secondary index. *
*/ public ProvisionedThroughput getProvisionedThroughput() { return provisionedThroughput; } /** ** Represents the provisioned throughput settings for the specified global * secondary index. *
* * @param provisionedThroughput* Represents the provisioned throughput settings for the * specified global secondary index. *
*/ public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput) { this.provisionedThroughput = provisionedThroughput; } /** ** Represents the provisioned throughput settings for the specified global * secondary index. *
** Returns a reference to this object so that method calls can be chained * together. * * @param provisionedThroughput
* Represents the provisioned throughput settings for the * specified global secondary index. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GlobalSecondaryIndexInfo withProvisionedThroughput( ProvisionedThroughput provisionedThroughput) { this.provisionedThroughput = provisionedThroughput; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @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: " + getIndexName() + ","); if (getKeySchema() != null) sb.append("KeySchema: " + getKeySchema() + ","); if (getProjection() != null) sb.append("Projection: " + getProjection() + ","); if (getProvisionedThroughput() != null) sb.append("ProvisionedThroughput: " + getProvisionedThroughput()); sb.append("}"); return sb.toString(); } @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 boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GlobalSecondaryIndexInfo == false) return false; GlobalSecondaryIndexInfo other = (GlobalSecondaryIndexInfo) 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; } }