/*
* Copyright 2010-2016 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;
/**
* <p>
* Represents the properties of a global secondary index.
* </p>
*/
public class GlobalSecondaryIndex implements Serializable {
/**
* <p>
* The name of the global secondary index. The name must be unique among all
* other indexes on this table.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>3 - 255<br/>
* <b>Pattern: </b>[a-zA-Z0-9_.-]+<br/>
*/
private String indexName;
/**
* <p>
* The complete key schema for a global secondary index, which consists of
* one or more pairs of attribute names and key types:
* </p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key
* </p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key
* </p>
* </li>
* </ul>
* <note>
* <p>
* The partition key of an item is also known as its <i>hash attribute</i>.
* 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.
* </p>
* <p>
* The sort key of an item is also known as its <i>range attribute</i>. 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.
* </p>
* </note>
*/
private java.util.List<KeySchemaElement> keySchema;
/**
* <p>
* Represents attributes that are copied (projected) from the table into an
* index. These are in addition to the primary key attributes and index key
* attributes, which are automatically projected.
* </p>
*/
private Projection projection;
/**
* <p>
* Represents the provisioned throughput settings for a specified table or
* index. The settings can be modified using the <i>UpdateTable</i>
* operation.
* </p>
* <p>
* For current minimum and maximum provisioned throughput values, see <a
* href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html"
* >Limits</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
*/
private ProvisionedThroughput provisionedThroughput;
/**
* <p>
* The name of the global secondary index. The name must be unique among all
* other indexes on this table.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>3 - 255<br/>
* <b>Pattern: </b>[a-zA-Z0-9_.-]+<br/>
*
* @return <p>
* The name of the global secondary index. The name must be unique
* among all other indexes on this table.
* </p>
*/
public String getIndexName() {
return indexName;
}
/**
* <p>
* The name of the global secondary index. The name must be unique among all
* other indexes on this table.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>3 - 255<br/>
* <b>Pattern: </b>[a-zA-Z0-9_.-]+<br/>
*
* @param indexName <p>
* The name of the global secondary index. The name must be
* unique among all other indexes on this table.
* </p>
*/
public void setIndexName(String indexName) {
this.indexName = indexName;
}
/**
* <p>
* The name of the global secondary index. The name must be unique among all
* other indexes on this table.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>3 - 255<br/>
* <b>Pattern: </b>[a-zA-Z0-9_.-]+<br/>
*
* @param indexName <p>
* The name of the global secondary index. The name must be
* unique among all other indexes on this table.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GlobalSecondaryIndex withIndexName(String indexName) {
this.indexName = indexName;
return this;
}
/**
* <p>
* The complete key schema for a global secondary index, which consists of
* one or more pairs of attribute names and key types:
* </p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key
* </p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key
* </p>
* </li>
* </ul>
* <note>
* <p>
* The partition key of an item is also known as its <i>hash attribute</i>.
* 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.
* </p>
* <p>
* The sort key of an item is also known as its <i>range attribute</i>. 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.
* </p>
* </note>
*
* @return <p>
* The complete key schema for a global secondary index, which
* consists of one or more pairs of attribute names and key types:
* </p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key
* </p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key
* </p>
* </li>
* </ul>
* <note>
* <p>
* The partition key of an item is also known as its <i>hash
* attribute</i>. 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.
* </p>
* <p>
* The sort key of an item is also known as its <i>range
* attribute</i>. 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.
* </p>
* </note>
*/
public java.util.List<KeySchemaElement> getKeySchema() {
return keySchema;
}
/**
* <p>
* The complete key schema for a global secondary index, which consists of
* one or more pairs of attribute names and key types:
* </p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key
* </p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key
* </p>
* </li>
* </ul>
* <note>
* <p>
* The partition key of an item is also known as its <i>hash attribute</i>.
* 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.
* </p>
* <p>
* The sort key of an item is also known as its <i>range attribute</i>. 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.
* </p>
* </note>
*
* @param keySchema <p>
* The complete key schema for a global secondary index, which
* consists of one or more pairs of attribute names and key
* types:
* </p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key
* </p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key
* </p>
* </li>
* </ul>
* <note>
* <p>
* The partition key of an item is also known as its <i>hash
* attribute</i>. 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.
* </p>
* <p>
* The sort key of an item is also known as its <i>range
* attribute</i>. 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.
* </p>
* </note>
*/
public void setKeySchema(java.util.Collection<KeySchemaElement> keySchema) {
if (keySchema == null) {
this.keySchema = null;
return;
}
this.keySchema = new java.util.ArrayList<KeySchemaElement>(keySchema);
}
/**
* <p>
* The complete key schema for a global secondary index, which consists of
* one or more pairs of attribute names and key types:
* </p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key
* </p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key
* </p>
* </li>
* </ul>
* <note>
* <p>
* The partition key of an item is also known as its <i>hash attribute</i>.
* 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.
* </p>
* <p>
* The sort key of an item is also known as its <i>range attribute</i>. 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.
* </p>
* </note>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param keySchema <p>
* The complete key schema for a global secondary index, which
* consists of one or more pairs of attribute names and key
* types:
* </p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key
* </p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key
* </p>
* </li>
* </ul>
* <note>
* <p>
* The partition key of an item is also known as its <i>hash
* attribute</i>. 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.
* </p>
* <p>
* The sort key of an item is also known as its <i>range
* attribute</i>. 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.
* </p>
* </note>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GlobalSecondaryIndex withKeySchema(KeySchemaElement... keySchema) {
if (getKeySchema() == null) {
this.keySchema = new java.util.ArrayList<KeySchemaElement>(keySchema.length);
}
for (KeySchemaElement value : keySchema) {
this.keySchema.add(value);
}
return this;
}
/**
* <p>
* The complete key schema for a global secondary index, which consists of
* one or more pairs of attribute names and key types:
* </p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key
* </p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key
* </p>
* </li>
* </ul>
* <note>
* <p>
* The partition key of an item is also known as its <i>hash attribute</i>.
* 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.
* </p>
* <p>
* The sort key of an item is also known as its <i>range attribute</i>. 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.
* </p>
* </note>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param keySchema <p>
* The complete key schema for a global secondary index, which
* consists of one or more pairs of attribute names and key
* types:
* </p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key
* </p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key
* </p>
* </li>
* </ul>
* <note>
* <p>
* The partition key of an item is also known as its <i>hash
* attribute</i>. 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.
* </p>
* <p>
* The sort key of an item is also known as its <i>range
* attribute</i>. 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.
* </p>
* </note>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GlobalSecondaryIndex withKeySchema(java.util.Collection<KeySchemaElement> keySchema) {
setKeySchema(keySchema);
return this;
}
/**
* <p>
* Represents attributes that are copied (projected) from the table into an
* index. These are in addition to the primary key attributes and index key
* attributes, which are automatically projected.
* </p>
*
* @return <p>
* Represents attributes that are copied (projected) from the table
* into an index. These are in addition to the primary key
* attributes and index key attributes, which are automatically
* projected.
* </p>
*/
public Projection getProjection() {
return projection;
}
/**
* <p>
* Represents attributes that are copied (projected) from the table into an
* index. These are in addition to the primary key attributes and index key
* attributes, which are automatically projected.
* </p>
*
* @param projection <p>
* Represents attributes that are copied (projected) from the
* table into an index. These are in addition to the primary key
* attributes and index key attributes, which are automatically
* projected.
* </p>
*/
public void setProjection(Projection projection) {
this.projection = projection;
}
/**
* <p>
* Represents attributes that are copied (projected) from the table into an
* index. These are in addition to the primary key attributes and index key
* attributes, which are automatically projected.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param projection <p>
* Represents attributes that are copied (projected) from the
* table into an index. These are in addition to the primary key
* attributes and index key attributes, which are automatically
* projected.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GlobalSecondaryIndex withProjection(Projection projection) {
this.projection = projection;
return this;
}
/**
* <p>
* Represents the provisioned throughput settings for a specified table or
* index. The settings can be modified using the <i>UpdateTable</i>
* operation.
* </p>
* <p>
* For current minimum and maximum provisioned throughput values, see <a
* href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html"
* >Limits</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
*
* @return <p>
* Represents the provisioned throughput settings for a specified
* table or index. The settings can be modified using the
* <i>UpdateTable</i> operation.
* </p>
* <p>
* For current minimum and maximum provisioned throughput values,
* see <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html"
* >Limits</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
*/
public ProvisionedThroughput getProvisionedThroughput() {
return provisionedThroughput;
}
/**
* <p>
* Represents the provisioned throughput settings for a specified table or
* index. The settings can be modified using the <i>UpdateTable</i>
* operation.
* </p>
* <p>
* For current minimum and maximum provisioned throughput values, see <a
* href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html"
* >Limits</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
*
* @param provisionedThroughput <p>
* Represents the provisioned throughput settings for a specified
* table or index. The settings can be modified using the
* <i>UpdateTable</i> operation.
* </p>
* <p>
* For current minimum and maximum provisioned throughput values,
* see <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html"
* >Limits</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
*/
public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput) {
this.provisionedThroughput = provisionedThroughput;
}
/**
* <p>
* Represents the provisioned throughput settings for a specified table or
* index. The settings can be modified using the <i>UpdateTable</i>
* operation.
* </p>
* <p>
* For current minimum and maximum provisioned throughput values, see <a
* href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html"
* >Limits</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param provisionedThroughput <p>
* Represents the provisioned throughput settings for a specified
* table or index. The settings can be modified using the
* <i>UpdateTable</i> operation.
* </p>
* <p>
* For current minimum and maximum provisioned throughput values,
* see <a href=
* "http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html"
* >Limits</a> in the <i>Amazon DynamoDB Developer Guide</i>.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GlobalSecondaryIndex 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 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;
}
}