Package software.amazon.awssdk.services.dynamodb.model

Interface GlobalSecondaryIndexUpdate.Builder

All Superinterfaces:

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

Enclosing class:

GlobalSecondaryIndexUpdate

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

Method Summary

Modifier and Type	Method	Description
default GlobalSecondaryIndexUpdate.Builder	create(Consumer<CreateGlobalSecondaryIndexAction.Builder> create)	The parameters required for creating a global secondary index on an existing table:
GlobalSecondaryIndexUpdate.Builder	create(CreateGlobalSecondaryIndexAction create)	The parameters required for creating a global secondary index on an existing table:
default GlobalSecondaryIndexUpdate.Builder	delete(Consumer<DeleteGlobalSecondaryIndexAction.Builder> delete)	The name of an existing global secondary index to be removed.
GlobalSecondaryIndexUpdate.Builder	delete(DeleteGlobalSecondaryIndexAction delete)	The name of an existing global secondary index to be removed.
default GlobalSecondaryIndexUpdate.Builder	update(Consumer<UpdateGlobalSecondaryIndexAction.Builder> update)	The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
GlobalSecondaryIndexUpdate.Builder	update(UpdateGlobalSecondaryIndexAction update)	The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that 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 Detail

update

GlobalSecondaryIndexUpdate.Builder update(UpdateGlobalSecondaryIndexAction update)

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

Parameters:

update - The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

Returns:

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

update

default GlobalSecondaryIndexUpdate.Builder update(Consumer<UpdateGlobalSecondaryIndexAction.Builder> update)

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

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

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

Parameters:

update - a consumer that will call methods on UpdateGlobalSecondaryIndexAction.Builder

Returns:

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

See Also:

update(UpdateGlobalSecondaryIndexAction)

create

GlobalSecondaryIndexUpdate.Builder create(CreateGlobalSecondaryIndexAction create)

The parameters required for creating a global secondary index on an existing table:

• IndexName

• KeySchema

• AttributeDefinitions

• Projection

• ProvisionedThroughput

Parameters:

create - The parameters required for creating a global secondary index on an existing table:

• IndexName

• KeySchema

• AttributeDefinitions

• Projection

• ProvisionedThroughput

Returns:

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

create

default GlobalSecondaryIndexUpdate.Builder create(Consumer<CreateGlobalSecondaryIndexAction.Builder> create)

The parameters required for creating a global secondary index on an existing table:

• IndexName

• KeySchema

• AttributeDefinitions

• Projection

• ProvisionedThroughput

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

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

Parameters:

create - a consumer that will call methods on CreateGlobalSecondaryIndexAction.Builder

Returns:

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

See Also:

create(CreateGlobalSecondaryIndexAction)

delete

GlobalSecondaryIndexUpdate.Builder delete(DeleteGlobalSecondaryIndexAction delete)

The name of an existing global secondary index to be removed.

Parameters:

delete - The name of an existing global secondary index to be removed.

Returns:

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

delete

default GlobalSecondaryIndexUpdate.Builder delete(Consumer<DeleteGlobalSecondaryIndexAction.Builder> delete)

The name of an existing global secondary index to be removed.

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

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

Parameters:

delete - a consumer that will call methods on DeleteGlobalSecondaryIndexAction.Builder

Returns:

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

See Also:

delete(DeleteGlobalSecondaryIndexAction)