com.amazonaws.services.dynamodbv2.model
Class GlobalSecondaryIndexDescription

java.lang.Object
  com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription

All Implemented Interfaces:

java.io.Serializable

public class GlobalSecondaryIndexDescription
extends java.lang.Object
implements java.io.Serializable

Represents the properties of a global secondary index.

See Also:

Serialized Form

Constructor Summary

GlobalSecondaryIndexDescription()

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getIndexName() The name of the global secondary index.
java.lang.Long	getIndexSizeBytes() The total size of the specified index, in bytes.
java.lang.String	getIndexStatus() The current state of the global secondary index:
java.lang.Long	getItemCount() The number of items in the specified index.
java.util.List<KeySchemaElement>	getKeySchema() The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).
Projection	getProjection() Represents attributes that are copied (projected) from the table into an index.
ProvisionedThroughputDescription	getProvisionedThroughput() Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
int	hashCode()
void	setIndexName(java.lang.String indexName) The name of the global secondary index.
void	setIndexSizeBytes(java.lang.Long indexSizeBytes) The total size of the specified index, in bytes.
void	setIndexStatus(IndexStatus indexStatus) The current state of the global secondary index:
void	setIndexStatus(java.lang.String indexStatus) The current state of the global secondary index:
void	setItemCount(java.lang.Long itemCount) The number of items in the specified index.
void	setKeySchema(java.util.Collection<KeySchemaElement> keySchema) The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).
void	setProjection(Projection projection) Represents attributes that are copied (projected) from the table into an index.
void	setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput) Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GlobalSecondaryIndexDescription	withIndexName(java.lang.String indexName) The name of the global secondary index.
GlobalSecondaryIndexDescription	withIndexSizeBytes(java.lang.Long indexSizeBytes) The total size of the specified index, in bytes.
GlobalSecondaryIndexDescription	withIndexStatus(IndexStatus indexStatus) The current state of the global secondary index:
GlobalSecondaryIndexDescription	withIndexStatus(java.lang.String indexStatus) The current state of the global secondary index:
GlobalSecondaryIndexDescription	withItemCount(java.lang.Long itemCount) The number of items in the specified index.
GlobalSecondaryIndexDescription	withKeySchema(java.util.Collection<KeySchemaElement> keySchema) The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).
GlobalSecondaryIndexDescription	withKeySchema(KeySchemaElement... keySchema) The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).
GlobalSecondaryIndexDescription	withProjection(Projection projection) Represents attributes that are copied (projected) from the table into an index.
GlobalSecondaryIndexDescription	withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput) Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlobalSecondaryIndexDescription

public GlobalSecondaryIndexDescription()

Method Detail

getIndexName

public java.lang.String getIndexName()

The name of the global secondary index.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the global secondary index.

setIndexName

public void setIndexName(java.lang.String indexName)

The name of the global secondary index.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

indexName - The name of the global secondary index.

withIndexName

public GlobalSecondaryIndexDescription withIndexName(java.lang.String 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_.-]+

Parameters:

indexName - The name of the global secondary index.

Returns:

A reference to this updated object so that method calls can be chained together.

getKeySchema

public java.util.List<KeySchemaElement> getKeySchema()

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

Constraints:
Length: 1 - 2

Returns:

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

setKeySchema

public void setKeySchema(java.util.Collection<KeySchemaElement> keySchema)

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

Constraints:
Length: 1 - 2

Parameters:

keySchema - The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

withKeySchema

public GlobalSecondaryIndexDescription withKeySchema(KeySchemaElement... keySchema)

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

Parameters:

keySchema - The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

Returns:

A reference to this updated object so that method calls can be chained together.

withKeySchema

public GlobalSecondaryIndexDescription withKeySchema(java.util.Collection<KeySchemaElement> keySchema)

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

Parameters:

keySchema - The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (HASH or RANGE).

Returns:

A reference to this updated object so that method calls can be chained together.

getProjection

public Projection getProjection()

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.

Returns:

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.

setProjection

public void setProjection(Projection projection)

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.

Parameters:

projection - 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.

withProjection

public GlobalSecondaryIndexDescription withProjection(Projection projection)

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

projection - 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getIndexStatus

public java.lang.String getIndexStatus()

The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Returns:

The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

See Also:

IndexStatus

setIndexStatus

public void setIndexStatus(java.lang.String indexStatus)

The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Parameters:

indexStatus - The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

See Also:

IndexStatus

withIndexStatus

public GlobalSecondaryIndexDescription withIndexStatus(java.lang.String indexStatus)

The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Parameters:

indexStatus - The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

IndexStatus

setIndexStatus

public void setIndexStatus(IndexStatus indexStatus)

The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Parameters:

indexStatus - The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

See Also:

IndexStatus

withIndexStatus

public GlobalSecondaryIndexDescription withIndexStatus(IndexStatus indexStatus)

The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE

Parameters:

indexStatus - The current state of the global secondary index:

• CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.

• UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.

• DELETING - The index is being deleted, as the result of a DeleteTable operation.

• ACTIVE - The index is ready for use.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

IndexStatus

getProvisionedThroughput

public ProvisionedThroughputDescription getProvisionedThroughput()

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Returns:

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

setProvisionedThroughput

public void setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

withProvisionedThroughput

public GlobalSecondaryIndexDescription withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Returns a reference to this object so that method calls can be chained together.

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Returns:

A reference to this updated object so that method calls can be chained together.

getIndexSizeBytes

public java.lang.Long getIndexSizeBytes()

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.

Returns:

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.

setIndexSizeBytes

public void setIndexSizeBytes(java.lang.Long 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.

Parameters:

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.

withIndexSizeBytes

public GlobalSecondaryIndexDescription withIndexSizeBytes(java.lang.Long 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getItemCount

public java.lang.Long getItemCount()

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.

Returns:

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.

setItemCount

public void setItemCount(java.lang.Long 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.

Parameters:

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.

withItemCount

public GlobalSecondaryIndexDescription withItemCount(java.lang.Long 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object