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

Interface GlobalSecondaryIndexInfo.Builder

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

  • Method Details

    • indexName

      GlobalSecondaryIndexInfo.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

      GlobalSecondaryIndexInfo.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

      GlobalSecondaryIndexInfo.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

      GlobalSecondaryIndexInfo.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

      GlobalSecondaryIndexInfo.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 GlobalSecondaryIndexInfo.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:

    • provisionedThroughput

      GlobalSecondaryIndexInfo.Builder provisionedThroughput(ProvisionedThroughput provisionedThroughput)

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

      Parameters:
      provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • provisionedThroughput

      default GlobalSecondaryIndexInfo.Builder provisionedThroughput(Consumer<ProvisionedThroughput.Builder> provisionedThroughput)

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

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

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

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