CreateGlobalSecondaryIndexAction (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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 ()

Constructors
Constructor and Description
`CreateGlobalSecondaryIndexAction ()`

Method Summary

All 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.
`OnDemandThroughput`	`getOnDemandThroughput ()` The maximum number of read and write units for the global secondary index being created.
`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)` Marshalls this structured data using the given `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`	`setOnDemandThroughput (OnDemandThroughput onDemandThroughput)` The maximum number of read and write units for the global secondary index being created.
`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`	`withOnDemandThroughput (OnDemandThroughput onDemandThroughput)` The maximum number of read and write units for the global secondary index being created.
`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
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.
  - setOnDemandThroughput
```
public void setOnDemandThroughput(OnDemandThroughput onDemandThroughput)
```
    The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
    
    Parameters:
    
    onDemandThroughput - The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
  - getOnDemandThroughput
```
public OnDemandThroughput getOnDemandThroughput()
```
    The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
    
    Returns:
    
    The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
  - withOnDemandThroughput
```
public CreateGlobalSecondaryIndexAction withOnDemandThroughput(OnDemandThroughput onDemandThroughput)
```
    The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
    
    Parameters:
    
    onDemandThroughput - The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
    
    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)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class CreateGlobalSecondaryIndexAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateGlobalSecondaryIndexAction

Method Detail

setIndexName

getIndexName

withIndexName

getKeySchema

setKeySchema

withKeySchema

withKeySchema

setProjection

getProjection

withProjection

setProvisionedThroughput

getProvisionedThroughput

withProvisionedThroughput

setOnDemandThroughput

getOnDemandThroughput

withOnDemandThroughput

toString

equals

hashCode

clone

marshall