@Generated(value="software.amazon.awssdk:codegen") public final class GlobalSecondaryIndex extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GlobalSecondaryIndex.Builder,GlobalSecondaryIndex>
Represents the properties of a global secondary index.
Modifier and Type | Class and Description |
---|---|
static interface |
GlobalSecondaryIndex.Builder |
Modifier and Type | Method and Description |
---|---|
static GlobalSecondaryIndex.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasKeySchema()
For responses, this returns true if the service returned a value for the KeySchema property.
|
String |
indexName()
The name of the global secondary index.
|
List<KeySchemaElement> |
keySchema()
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and
key types:
|
Projection |
projection()
Represents attributes that are copied (projected) from the table into the global secondary index.
|
ProvisionedThroughput |
provisionedThroughput()
Represents the provisioned throughput settings for the specified global secondary index.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GlobalSecondaryIndex.Builder> |
serializableBuilderClass() |
GlobalSecondaryIndex.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String indexName()
The name of the global secondary index. The name must be unique among all other indexes on this table.
public final boolean hasKeySchema()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasKeySchema()
method.
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.
public final 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.
public final ProvisionedThroughput 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.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
public GlobalSecondaryIndex.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GlobalSecondaryIndex.Builder,GlobalSecondaryIndex>
public static GlobalSecondaryIndex.Builder builder()
public static Class<? extends GlobalSecondaryIndex.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.