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 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, as KeySchemaElement 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, as KeySchemaElement 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.

      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 keys(List<KeySchemaElement>).

      Parameters:
      keys - 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:
    • 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:
    • 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

      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

      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 the BackfillError.Builder avoiding the need to create one manually via BackfillError.builder().

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

      Parameters:
      backfillErrors - a consumer that will call methods on BackfillError.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: