com.amazonaws.services.dynamodbv2.model

Class CreateGlobalSecondaryIndexAction

java.lang.Object

com.amazonaws.services.dynamodbv2.model.CreateGlobalSecondaryIndexAction

All Implemented Interfaces:

Serializable, Cloneable

public class CreateGlobalSecondaryIndexAction
extends Object
implements Serializable, Cloneable

Represents a new global secondary index to be added to an existing table.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateGlobalSecondaryIndexAction()

Method Summary

Methods

Modifier and Type	Method and Description
CreateGlobalSecondaryIndexAction	clone()
boolean	equals(Object obj)
String	getIndexName() The name of the global secondary index to be created.
List<KeySchemaElement>	getKeySchema() The key schema for the global secondary index.
Projection	getProjection() Represents attributes that are copied (projected) from the table into an index.
ProvisionedThroughput	getProvisionedThroughput() Represents the provisioned throughput settings for a specified table or index.
int	hashCode()
void	setIndexName(String indexName) The name of the global secondary index to be created.
void	setKeySchema(Collection<KeySchemaElement> keySchema) The key schema for the global secondary index.
void	setProjection(Projection projection) Represents attributes that are copied (projected) from the table into an index.
void	setProvisionedThroughput(ProvisionedThroughput provisionedThroughput) Represents the provisioned throughput settings for a specified table or index.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateGlobalSecondaryIndexAction	withIndexName(String indexName) The name of the global secondary index to be created.
CreateGlobalSecondaryIndexAction	withKeySchema(Collection<KeySchemaElement> keySchema) The key schema for the global secondary index.
CreateGlobalSecondaryIndexAction	withKeySchema(KeySchemaElement... keySchema) The key schema for the global secondary index.
CreateGlobalSecondaryIndexAction	withProjection(Projection projection) Represents attributes that are copied (projected) from the table into an index.
CreateGlobalSecondaryIndexAction	withProvisionedThroughput(ProvisionedThroughput provisionedThroughput) Represents the provisioned throughput settings for a specified table or index.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateGlobalSecondaryIndexAction

public CreateGlobalSecondaryIndexAction()

Method Detail

getIndexName

public String getIndexName()

The name of the global secondary index to be created.

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

Returns:

The name of the global secondary index to be created.

setIndexName

public void setIndexName(String indexName)

The name of the global secondary index to be created.

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

Parameters:

indexName - The name of the global secondary index to be created.

withIndexName

public CreateGlobalSecondaryIndexAction withIndexName(String indexName)

The name of the global secondary index to be created.

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 to be created.

Returns:

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

getKeySchema

public List<KeySchemaElement> getKeySchema()

The key schema for the global secondary index.

Constraints:
Length: 1 - 2

Returns:

The key schema for the global secondary index.

setKeySchema

public void setKeySchema(Collection<KeySchemaElement> keySchema)

The key schema for the global secondary index.

Constraints:
Length: 1 - 2

Parameters:

keySchema - The key schema for the global secondary index.

withKeySchema

public CreateGlobalSecondaryIndexAction withKeySchema(KeySchemaElement... keySchema)

The key schema for the global secondary index.

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

Constraints:
Length: 1 - 2

Parameters:

keySchema - The key schema for the global secondary index.

Returns:

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

withKeySchema

public CreateGlobalSecondaryIndexAction withKeySchema(Collection<KeySchemaElement> keySchema)

The key schema for the global secondary index.

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

Constraints:
Length: 1 - 2

Parameters:

keySchema - The key schema for the global secondary index.

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

getProvisionedThroughput

public ProvisionedThroughput getProvisionedThroughput()

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Returns:

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

setProvisionedThroughput

public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

withProvisionedThroughput

public CreateGlobalSecondaryIndexAction withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

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

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateGlobalSecondaryIndexAction clone()

Overrides:

clone in class Object