Interface PartitionIndexDescriptor.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<PartitionIndexDescriptor.Builder,PartitionIndexDescriptor>
,SdkBuilder<PartitionIndexDescriptor.Builder,PartitionIndexDescriptor>
,SdkPojo
- Enclosing class:
- PartitionIndexDescriptor
public static interface PartitionIndexDescriptor.Builder extends SdkPojo, CopyableBuilder<PartitionIndexDescriptor.Builder,PartitionIndexDescriptor>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PartitionIndexDescriptor.Builder
backfillErrors(Collection<BackfillError> backfillErrors)
A list of errors that can occur when registering partition indexes for an existing table.PartitionIndexDescriptor.Builder
backfillErrors(Consumer<BackfillError.Builder>... backfillErrors)
A list of errors that can occur when registering partition indexes for an existing table.PartitionIndexDescriptor.Builder
backfillErrors(BackfillError... backfillErrors)
A list of errors that can occur when registering partition indexes for an existing table.PartitionIndexDescriptor.Builder
indexName(String indexName)
The name of the partition index.PartitionIndexDescriptor.Builder
indexStatus(String indexStatus)
The status of the partition index.PartitionIndexDescriptor.Builder
indexStatus(PartitionIndexStatus indexStatus)
The status of the partition index.PartitionIndexDescriptor.Builder
keys(Collection<KeySchemaElement> keys)
A list of one or more keys, asKeySchemaElement
structures, for the partition index.PartitionIndexDescriptor.Builder
keys(Consumer<KeySchemaElement.Builder>... keys)
A list of one or more keys, asKeySchemaElement
structures, for the partition index.PartitionIndexDescriptor.Builder
keys(KeySchemaElement... keys)
A list of one or more keys, asKeySchemaElement
structures, for the partition 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, sdkFields
-
-
-
-
Method Detail
-
indexName
PartitionIndexDescriptor.Builder indexName(String indexName)
The name of the partition index.
- Parameters:
indexName
- The name of the partition index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keys
PartitionIndexDescriptor.Builder keys(Collection<KeySchemaElement> keys)
A list of one or more keys, as
KeySchemaElement
structures, for the partition index.- Parameters:
keys
- A list of one or more keys, asKeySchemaElement
structures, for the partition index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keys
PartitionIndexDescriptor.Builder keys(KeySchemaElement... keys)
A list of one or more keys, as
KeySchemaElement
structures, for the partition index.- Parameters:
keys
- A list of one or more keys, asKeySchemaElement
structures, for the partition index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keys
PartitionIndexDescriptor.Builder keys(Consumer<KeySchemaElement.Builder>... keys)
A list of one or more keys, as
This is a convenience method that creates an instance of theKeySchemaElement
structures, for the partition index.KeySchemaElement.Builder
avoiding the need to create one manually viaKeySchemaElement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#keys(List
.) - Parameters:
keys
- a consumer that will call methods onKeySchemaElement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#keys(java.util.Collection
)
-
indexStatus
PartitionIndexDescriptor.Builder indexStatus(String indexStatus)
The status of the partition index.
The possible statuses are:
-
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
-
ACTIVE: The index creation succeeds.
-
FAILED: The index creation fails.
-
DELETING: The index is deleted from the list of indexes.
- Parameters:
indexStatus
- The status of the partition index.The possible statuses are:
-
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
-
ACTIVE: The index creation succeeds.
-
FAILED: The index creation fails.
-
DELETING: The index is deleted from the list of indexes.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PartitionIndexStatus
,PartitionIndexStatus
-
-
indexStatus
PartitionIndexDescriptor.Builder indexStatus(PartitionIndexStatus indexStatus)
The status of the partition index.
The possible statuses are:
-
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
-
ACTIVE: The index creation succeeds.
-
FAILED: The index creation fails.
-
DELETING: The index is deleted from the list of indexes.
- Parameters:
indexStatus
- The status of the partition index.The possible statuses are:
-
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
-
ACTIVE: The index creation succeeds.
-
FAILED: The index creation fails.
-
DELETING: The index is deleted from the list of indexes.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PartitionIndexStatus
,PartitionIndexStatus
-
-
backfillErrors
PartitionIndexDescriptor.Builder backfillErrors(Collection<BackfillError> backfillErrors)
A list of errors that can occur when registering partition indexes for an existing table.
- Parameters:
backfillErrors
- A list of errors that can occur when registering partition indexes for an existing table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backfillErrors
PartitionIndexDescriptor.Builder backfillErrors(BackfillError... backfillErrors)
A list of errors that can occur when registering partition indexes for an existing table.
- Parameters:
backfillErrors
- A list of errors that can occur when registering partition indexes for an existing table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backfillErrors
PartitionIndexDescriptor.Builder backfillErrors(Consumer<BackfillError.Builder>... backfillErrors)
A list of errors that can occur when registering partition indexes for an existing table.
This is a convenience method that creates an instance of theBackfillError.Builder
avoiding the need to create one manually viaBackfillError.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#backfillErrors(List
.) - Parameters:
backfillErrors
- a consumer that will call methods onBackfillError.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#backfillErrors(java.util.Collection
)
-
-