Interface PartitionIndexDescriptor.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<PartitionIndexDescriptor.Builder,
,PartitionIndexDescriptor> SdkBuilder<PartitionIndexDescriptor.Builder,
,PartitionIndexDescriptor> SdkPojo
- Enclosing class:
PartitionIndexDescriptor
-
Method Summary
Modifier and TypeMethodDescriptionbackfillErrors
(Collection<BackfillError> backfillErrors) A list of errors that can occur when registering partition indexes for an existing table.backfillErrors
(Consumer<BackfillError.Builder>... backfillErrors) A list of errors that can occur when registering partition indexes for an existing table.backfillErrors
(BackfillError... backfillErrors) A list of errors that can occur when registering partition indexes for an existing table.The name of the partition index.indexStatus
(String indexStatus) The status of the partition index.indexStatus
(PartitionIndexStatus indexStatus) The status of the partition index.keys
(Collection<KeySchemaElement> keys) A list of one or more keys, asKeySchemaElement
structures, for the partition index.keys
(Consumer<KeySchemaElement.Builder>... keys) A list of one or more keys, asKeySchemaElement
structures, for the partition index.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 Details
-
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
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
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
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 tokeys(List<KeySchemaElement>)
.- 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:
-
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:
-
-
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:
-
-
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
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
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 tobackfillErrors(List<BackfillError>)
.- 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:
-