com.amazonaws.services.dynamodbv2.model

Class CreateGlobalSecondaryIndexAction

java.lang.Object

com.amazonaws.services.dynamodbv2.model.CreateGlobalSecondaryIndexAction

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateGlobalSecondaryIndexAction
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateGlobalSecondaryIndexAction()

Method Summary

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 the specified global secondary index.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
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 the specified global secondary index.
String	toString() Returns a string representation of this object.
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 the specified global secondary index.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateGlobalSecondaryIndexAction

public CreateGlobalSecondaryIndexAction()

Method Detail

setIndexName

public void setIndexName(String indexName)

The name of the global secondary index to be created.

Parameters:

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

getIndexName

public String getIndexName()

The name of the global secondary index to be created.

Returns:

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.

Parameters:

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

Returns:

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

getKeySchema

public List<KeySchemaElement> getKeySchema()

The key schema for the global secondary index.

Returns:

The key schema for the global secondary index.

setKeySchema

public void setKeySchema(Collection<KeySchemaElement> keySchema)

The key schema for the global secondary index.

Parameters:

keySchema - The key schema for the global secondary index.

withKeySchema

public CreateGlobalSecondaryIndexAction withKeySchema(KeySchemaElement... keySchema)

The key schema for the global secondary index.

NOTE: This method appends the values to the existing list (if any). Use setKeySchema(java.util.Collection) or withKeySchema(java.util.Collection) if you want to override the existing values.

Parameters:

keySchema - The key schema for the global secondary index.

Returns:

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

withKeySchema

public CreateGlobalSecondaryIndexAction withKeySchema(Collection<KeySchemaElement> keySchema)

The key schema for the global secondary index.

Parameters:

keySchema - The key schema for the global secondary index.

Returns:

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

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.

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.

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.

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:

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

setProvisionedThroughput

public void setProvisionedThroughput(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.

Parameters:

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.

getProvisionedThroughput

public ProvisionedThroughput getProvisionedThroughput()

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.

Returns:

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.

withProvisionedThroughput

public CreateGlobalSecondaryIndexAction withProvisionedThroughput(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.

Parameters:

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.

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateGlobalSecondaryIndexAction clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo