java.lang.Object
- software.amazon.awssdk.services.dynamodb.model.CreateGlobalSecondaryIndexAction

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CreateGlobalSecondaryIndexAction.Builder,CreateGlobalSecondaryIndexAction>

@Generated("software.amazon.awssdk:codegen")
public final class CreateGlobalSecondaryIndexAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateGlobalSecondaryIndexAction.Builder,CreateGlobalSecondaryIndexAction>

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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateGlobalSecondaryIndexAction.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateGlobalSecondaryIndexAction.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasKeySchema()`	For responses, this returns true if the service returned a value for the KeySchema property.
`String`	`indexName()`	The name of the global secondary index to be created.
`List<KeySchemaElement>`	`keySchema()`	The key schema for the global secondary index.
`OnDemandThroughput`	`onDemandThroughput()`	The maximum number of read and write units for the global secondary index being created.
`Projection`	`projection()`	Represents attributes that are copied (projected) from the table into an index.
`ProvisionedThroughput`	`provisionedThroughput()`	Represents the provisioned throughput settings for the specified global secondary index.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateGlobalSecondaryIndexAction.Builder>`	`serializableBuilderClass()`
`CreateGlobalSecondaryIndexAction.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`WarmThroughput`	`warmThroughput()`	Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - indexName
```
public final String indexName()
```
    The name of the global secondary index to be created.
    
    Returns:
    
    The name of the global secondary index to be created.
  - hasKeySchema
```
public final boolean hasKeySchema()
```
    For responses, this returns true if the service returned a value for the KeySchema property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - keySchema
```
public final List<KeySchemaElement> keySchema()
```
    The key schema for the global secondary index.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasKeySchema() method.
    
    Returns:
    
    The key schema for the global secondary index.
  - projection
```
public final 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:
    
    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.
  - provisionedThroughput
```
public final 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.
    
    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.
  - onDemandThroughput
```
public final 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.
    
    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.
  - warmThroughput
```
public final WarmThroughput warmThroughput()
```
    Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.
    
    Returns:
    
    Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.
  - toBuilder
```
public CreateGlobalSecondaryIndexAction.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateGlobalSecondaryIndexAction.Builder,CreateGlobalSecondaryIndexAction>
  - builder
```
public static CreateGlobalSecondaryIndexAction.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateGlobalSecondaryIndexAction.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateGlobalSecondaryIndexAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

indexName

hasKeySchema

keySchema

projection

provisionedThroughput

onDemandThroughput

warmThroughput

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField