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

Interface GlobalSecondaryIndexDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GlobalSecondaryIndexDescription.Builder,GlobalSecondaryIndexDescription>, SdkBuilder<GlobalSecondaryIndexDescription.Builder,GlobalSecondaryIndexDescription>, SdkPojo
Enclosing class:
GlobalSecondaryIndexDescription
public static interface GlobalSecondaryIndexDescription.Builder extends SdkPojo, CopyableBuilder<GlobalSecondaryIndexDescription.Builder,GlobalSecondaryIndexDescription>

  • Method Details

    • indexName

      GlobalSecondaryIndexDescription.Builder indexName(String indexName)

      The name of the global secondary index.

      Parameters:
      indexName - The name of the global secondary index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keySchema

      GlobalSecondaryIndexDescription.Builder keySchema(Collection<KeySchemaElement> keySchema)

      The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

      • HASH - partition key

      • RANGE - sort key

      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

      Parameters:
      keySchema - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

      • HASH - partition key

      • RANGE - sort key

      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

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

    • keySchema

      GlobalSecondaryIndexDescription.Builder keySchema(KeySchemaElement... keySchema)

      The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

      • HASH - partition key

      • RANGE - sort key

      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

      Parameters:
      keySchema - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

      • HASH - partition key

      • RANGE - sort key

      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

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

    • keySchema

      GlobalSecondaryIndexDescription.Builder keySchema(Consumer<KeySchemaElement.Builder>... keySchema)

      The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

      • HASH - partition key

      • RANGE - sort key

      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

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

      Parameters:
      keySchema - 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:

    • projection

      GlobalSecondaryIndexDescription.Builder projection(Projection projection)

      Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

      Parameters:
      projection - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • projection

      default GlobalSecondaryIndexDescription.Builder projection(Consumer<Projection.Builder> projection)

      Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

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

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

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

    • indexStatus

      GlobalSecondaryIndexDescription.Builder indexStatus(String indexStatus)

      The current state of the global secondary index:

      • CREATING - The index is being created.

      • UPDATING - The index is being updated.

      • DELETING - The index is being deleted.

      • ACTIVE - The index is ready for use.

      Parameters:
      indexStatus - The current state of the global secondary index:

      • CREATING - The index is being created.

      • UPDATING - The index is being updated.

      • DELETING - The index is being deleted.

      • ACTIVE - The index is ready for use.

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

    • indexStatus

      GlobalSecondaryIndexDescription.Builder indexStatus(IndexStatus indexStatus)

      The current state of the global secondary index:

      • CREATING - The index is being created.

      • UPDATING - The index is being updated.

      • DELETING - The index is being deleted.

      • ACTIVE - The index is ready for use.

      Parameters:
      indexStatus - The current state of the global secondary index:

      • CREATING - The index is being created.

      • UPDATING - The index is being updated.

      • DELETING - The index is being deleted.

      • ACTIVE - The index is ready for use.

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

    • backfilling

      GlobalSecondaryIndexDescription.Builder backfilling(Boolean backfilling)

      Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

      You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false.

      For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

      Parameters:
      backfilling - Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

      You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false.

      For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

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

    • provisionedThroughput

      GlobalSecondaryIndexDescription.Builder provisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)

      Represents the provisioned throughput settings for the specified global secondary index.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

      Parameters:
      provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

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

    • provisionedThroughput

      default GlobalSecondaryIndexDescription.Builder provisionedThroughput(Consumer<ProvisionedThroughputDescription.Builder> provisionedThroughput)

      Represents the provisioned throughput settings for the specified global secondary index.

      For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

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

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

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

    • indexSizeBytes

      GlobalSecondaryIndexDescription.Builder indexSizeBytes(Long indexSizeBytes)

      The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      Parameters:
      indexSizeBytes - The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • itemCount

      GlobalSecondaryIndexDescription.Builder itemCount(Long itemCount)

      The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      Parameters:
      itemCount - The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexArn

      GlobalSecondaryIndexDescription.Builder indexArn(String indexArn)

      The Amazon Resource Name (ARN) that uniquely identifies the index.

      Parameters:
      indexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.