@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GlobalSecondaryIndexInfo extends Object implements Serializable, Cloneable, StructuredPojo
Represents the properties of a global secondary index for the table when the backup was created.
Constructor and Description |
---|
GlobalSecondaryIndexInfo() |
Modifier and Type | Method and Description |
---|---|
GlobalSecondaryIndexInfo |
clone() |
boolean |
equals(Object obj) |
String |
getIndexName()
The name of the global secondary index.
|
List<KeySchemaElement> |
getKeySchema()
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and
key types:
|
OnDemandThroughput |
getOnDemandThroughput() |
Projection |
getProjection()
Represents attributes that are copied (projected) from the table into the global secondary index.
|
ProvisionedThroughput |
getProvisionedThroughput()
Represents the provisioned throughput settings for the specified global secondary index.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setIndexName(String indexName)
The name of the global secondary index.
|
void |
setKeySchema(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:
|
void |
setOnDemandThroughput(OnDemandThroughput onDemandThroughput) |
void |
setProjection(Projection projection)
Represents attributes that are copied (projected) from the table into the global secondary index.
|
void |
setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
|
String |
toString()
Returns a string representation of this object.
|
GlobalSecondaryIndexInfo |
withIndexName(String indexName)
The name of the global secondary index.
|
GlobalSecondaryIndexInfo |
withKeySchema(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:
|
GlobalSecondaryIndexInfo |
withKeySchema(KeySchemaElement... keySchema)
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and
key types:
|
GlobalSecondaryIndexInfo |
withOnDemandThroughput(OnDemandThroughput onDemandThroughput) |
GlobalSecondaryIndexInfo |
withProjection(Projection projection)
Represents attributes that are copied (projected) from the table into the global secondary index.
|
GlobalSecondaryIndexInfo |
withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
|
public void setIndexName(String indexName)
The name of the global secondary index.
indexName
- The name of the global secondary index.public String getIndexName()
The name of the global secondary index.
public GlobalSecondaryIndexInfo withIndexName(String indexName)
The name of the global secondary index.
indexName
- The name of the global secondary index.public List<KeySchemaElement> getKeySchema()
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.
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 void setKeySchema(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.
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.
public GlobalSecondaryIndexInfo withKeySchema(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.
NOTE: This method appends the values to the existing list (if any). Use
setKeySchema(java.util.Collection)
or withKeySchema(java.util.Collection)
if you want to
override the existing values.
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.
public GlobalSecondaryIndexInfo withKeySchema(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.
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.
public void setProjection(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.
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 Projection getProjection()
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 GlobalSecondaryIndexInfo withProjection(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.
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 void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
provisionedThroughput
- Represents the provisioned throughput settings for the specified global secondary index.public ProvisionedThroughput getProvisionedThroughput()
Represents the provisioned throughput settings for the specified global secondary index.
public GlobalSecondaryIndexInfo withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for the specified global secondary index.
provisionedThroughput
- Represents the provisioned throughput settings for the specified global secondary index.public void setOnDemandThroughput(OnDemandThroughput onDemandThroughput)
onDemandThroughput
- public OnDemandThroughput getOnDemandThroughput()
public GlobalSecondaryIndexInfo withOnDemandThroughput(OnDemandThroughput onDemandThroughput)
onDemandThroughput
- public String toString()
toString
in class Object
Object.toString()
public GlobalSecondaryIndexInfo clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.