Interface AwsDynamoDbTableGlobalSecondaryIndex.Builder

All Superinterfaces:

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

Enclosing class:

AwsDynamoDbTableGlobalSecondaryIndex

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

Method Summary

Modifier and Type	Method	Description
AwsDynamoDbTableGlobalSecondaryIndex.Builder	backfilling(Boolean backfilling)	Whether the index is currently backfilling.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	indexArn(String indexArn)	The ARN of the index.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	indexName(String indexName)	The name of the index.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	indexSizeBytes(Long indexSizeBytes)	The total size in bytes of the index.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	indexStatus(String indexStatus)	The current status of the index.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	itemCount(Integer itemCount)	The number of items in the index.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	keySchema(Collection<AwsDynamoDbTableKeySchema> keySchema)	The key schema for the index.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	keySchema(Consumer<AwsDynamoDbTableKeySchema.Builder>... keySchema)	The key schema for the index.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	keySchema(AwsDynamoDbTableKeySchema... keySchema)	The key schema for the index.
default AwsDynamoDbTableGlobalSecondaryIndex.Builder	projection(Consumer<AwsDynamoDbTableProjection.Builder> projection)	Attributes that are copied from the table into an index.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	projection(AwsDynamoDbTableProjection projection)	Attributes that are copied from the table into an index.
default AwsDynamoDbTableGlobalSecondaryIndex.Builder	provisionedThroughput(Consumer<AwsDynamoDbTableProvisionedThroughput.Builder> provisionedThroughput)	Information about the provisioned throughput settings for the indexes.
AwsDynamoDbTableGlobalSecondaryIndex.Builder	provisionedThroughput(AwsDynamoDbTableProvisionedThroughput provisionedThroughput)	Information about the provisioned throughput settings for the indexes.

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

backfilling

AwsDynamoDbTableGlobalSecondaryIndex.Builder backfilling(Boolean backfilling)

Whether the index is currently backfilling.

Parameters:

backfilling - Whether the index is currently backfilling.

Returns:

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

indexArn

AwsDynamoDbTableGlobalSecondaryIndex.Builder indexArn(String indexArn)

The ARN of the index.

Parameters:

indexArn - The ARN of the index.

Returns:

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

indexName

AwsDynamoDbTableGlobalSecondaryIndex.Builder indexName(String indexName)

The name of the index.

Parameters:

indexName - The name of the index.

Returns:

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

indexSizeBytes

AwsDynamoDbTableGlobalSecondaryIndex.Builder indexSizeBytes(Long indexSizeBytes)

The total size in bytes of the index.

Parameters:

indexSizeBytes - The total size in bytes of the index.

Returns:

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

indexStatus

AwsDynamoDbTableGlobalSecondaryIndex.Builder indexStatus(String indexStatus)

The current status of the index.

• ACTIVE

• CREATING

• DELETING

• UPDATING

Parameters:

indexStatus - The current status of the index.

• ACTIVE

• CREATING

• DELETING

• UPDATING

Returns:

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

itemCount

AwsDynamoDbTableGlobalSecondaryIndex.Builder itemCount(Integer itemCount)

The number of items in the index.

Parameters:

itemCount - The number of items in the index.

Returns:

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

keySchema

AwsDynamoDbTableGlobalSecondaryIndex.Builder keySchema(Collection<AwsDynamoDbTableKeySchema> keySchema)

The key schema for the index.

Parameters:

keySchema - The key schema for the index.

Returns:

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

keySchema

AwsDynamoDbTableGlobalSecondaryIndex.Builder keySchema(AwsDynamoDbTableKeySchema... keySchema)

The key schema for the index.

Parameters:

keySchema - The key schema for the index.

Returns:

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

keySchema

AwsDynamoDbTableGlobalSecondaryIndex.Builder keySchema(Consumer<AwsDynamoDbTableKeySchema.Builder>... keySchema)

The key schema for the index.

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

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

Parameters:

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

Returns:

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

See Also:

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

projection

AwsDynamoDbTableGlobalSecondaryIndex.Builder projection(AwsDynamoDbTableProjection projection)

Attributes that are copied from the table into an index.

Parameters:

projection - Attributes that are copied from the table into an index.

Returns:

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

projection

default AwsDynamoDbTableGlobalSecondaryIndex.Builder projection(Consumer<AwsDynamoDbTableProjection.Builder> projection)

Attributes that are copied from the table into an index.

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

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

Parameters:

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

Returns:

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

See Also:

• projection(AwsDynamoDbTableProjection)

provisionedThroughput

AwsDynamoDbTableGlobalSecondaryIndex.Builder provisionedThroughput(AwsDynamoDbTableProvisionedThroughput provisionedThroughput)

Information about the provisioned throughput settings for the indexes.

Parameters:

provisionedThroughput - Information about the provisioned throughput settings for the indexes.

Returns:

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

provisionedThroughput

default AwsDynamoDbTableGlobalSecondaryIndex.Builder provisionedThroughput(Consumer<AwsDynamoDbTableProvisionedThroughput.Builder> provisionedThroughput)

Information about the provisioned throughput settings for the indexes.

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

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

Parameters:

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

Returns:

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

See Also:

• provisionedThroughput(AwsDynamoDbTableProvisionedThroughput)