Interface CreateGlobalSecondaryIndexAction.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CreateGlobalSecondaryIndexAction.Builder,CreateGlobalSecondaryIndexAction>, SdkBuilder<CreateGlobalSecondaryIndexAction.Builder,CreateGlobalSecondaryIndexAction>, SdkPojo

Enclosing class:

CreateGlobalSecondaryIndexAction

@Mutable
@NotThreadSafe
public static interface CreateGlobalSecondaryIndexAction.Builder
extends SdkPojo, CopyableBuilder<CreateGlobalSecondaryIndexAction.Builder,CreateGlobalSecondaryIndexAction>

Method Summary

Modifier and Type	Method	Description
CreateGlobalSecondaryIndexAction.Builder	indexName(String indexName)	The name of the global secondary index to be created.
CreateGlobalSecondaryIndexAction.Builder	keySchema(Collection<KeySchemaElement> keySchema)	The key schema for the global secondary index.
CreateGlobalSecondaryIndexAction.Builder	keySchema(Consumer<KeySchemaElement.Builder>... keySchema)	The key schema for the global secondary index.
CreateGlobalSecondaryIndexAction.Builder	keySchema(KeySchemaElement... keySchema)	The key schema for the global secondary index.
default CreateGlobalSecondaryIndexAction.Builder	onDemandThroughput(Consumer<OnDemandThroughput.Builder> onDemandThroughput)	The maximum number of read and write units for the global secondary index being created.
CreateGlobalSecondaryIndexAction.Builder	onDemandThroughput(OnDemandThroughput onDemandThroughput)	The maximum number of read and write units for the global secondary index being created.
default CreateGlobalSecondaryIndexAction.Builder	projection(Consumer<Projection.Builder> projection)	Represents attributes that are copied (projected) from the table into an index.
CreateGlobalSecondaryIndexAction.Builder	projection(Projection projection)	Represents attributes that are copied (projected) from the table into an index.
default CreateGlobalSecondaryIndexAction.Builder	provisionedThroughput(Consumer<ProvisionedThroughput.Builder> provisionedThroughput)	Represents the provisioned throughput settings for the specified global secondary index.
CreateGlobalSecondaryIndexAction.Builder	provisionedThroughput(ProvisionedThroughput provisionedThroughput)	Represents the provisioned throughput settings for the specified global secondary index.
default CreateGlobalSecondaryIndexAction.Builder	warmThroughput(Consumer<WarmThroughput.Builder> warmThroughput)	Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.
CreateGlobalSecondaryIndexAction.Builder	warmThroughput(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 interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

indexName

CreateGlobalSecondaryIndexAction.Builder indexName(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.

keySchema

CreateGlobalSecondaryIndexAction.Builder keySchema(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.

keySchema

CreateGlobalSecondaryIndexAction.Builder keySchema(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.

keySchema

CreateGlobalSecondaryIndexAction.Builder keySchema(Consumer<KeySchemaElement.Builder>... keySchema)

The key schema for the global secondary index.

This is a convenience method that creates an instance of the KeySchemaElement.Builder avoiding the need to create one manually via KeySchemaElement.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to keySchema(List<KeySchemaElement>).

Parameters:

keySchema - a consumer that will call methods on KeySchemaElement.Builder

Returns:

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

See Also:

• keySchema(java.util.Collection<KeySchemaElement>)

projection

CreateGlobalSecondaryIndexAction.Builder projection(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.

projection

default CreateGlobalSecondaryIndexAction.Builder projection(Consumer<Projection.Builder> 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.

This is a convenience method that creates an instance of the Projection.Builder avoiding the need to create one manually via Projection.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to projection(Projection).

Parameters:

projection - a consumer that will call methods on Projection.Builder

Returns:

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

See Also:

• projection(Projection)

provisionedThroughput

CreateGlobalSecondaryIndexAction.Builder provisionedThroughput(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.

provisionedThroughput

default CreateGlobalSecondaryIndexAction.Builder provisionedThroughput(Consumer<ProvisionedThroughput.Builder> 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.

This is a convenience method that creates an instance of the ProvisionedThroughput.Builder avoiding the need to create one manually via ProvisionedThroughput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to provisionedThroughput(ProvisionedThroughput).

Parameters:

provisionedThroughput - a consumer that will call methods on ProvisionedThroughput.Builder

Returns:

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

See Also:

• provisionedThroughput(ProvisionedThroughput)

onDemandThroughput

CreateGlobalSecondaryIndexAction.Builder onDemandThroughput(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. You must use either OnDemand Throughput or ProvisionedThroughput based on your table's capacity mode.

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. You must use either OnDemand Throughput or ProvisionedThroughput based on your table's capacity mode.

Returns:

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

onDemandThroughput

default CreateGlobalSecondaryIndexAction.Builder onDemandThroughput(Consumer<OnDemandThroughput.Builder> 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. You must use either OnDemand Throughput or ProvisionedThroughput based on your table's capacity mode.

This is a convenience method that creates an instance of the OnDemandThroughput.Builder avoiding the need to create one manually via OnDemandThroughput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onDemandThroughput(OnDemandThroughput).

Parameters:

onDemandThroughput - a consumer that will call methods on OnDemandThroughput.Builder

Returns:

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

See Also:

• onDemandThroughput(OnDemandThroughput)

warmThroughput

CreateGlobalSecondaryIndexAction.Builder warmThroughput(WarmThroughput warmThroughput)

Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.

Parameters:

warmThroughput - Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.

Returns:

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

warmThroughput

default CreateGlobalSecondaryIndexAction.Builder warmThroughput(Consumer<WarmThroughput.Builder> warmThroughput)

Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.

This is a convenience method that creates an instance of the WarmThroughput.Builder avoiding the need to create one manually via WarmThroughput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to warmThroughput(WarmThroughput).

Parameters:

warmThroughput - a consumer that will call methods on WarmThroughput.Builder

Returns:

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

See Also:

• warmThroughput(WarmThroughput)