public class GlobalSecondaryIndex extends Object implements Serializable, Cloneable
Represents the properties of a global secondary index.
Constructor and Description |
---|
GlobalSecondaryIndex() |
Modifier and Type | Method and Description |
---|---|
GlobalSecondaryIndex |
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
(
HASH or RANGE ). |
Projection |
getProjection()
Represents attributes that are copied (projected) from the table into
an index.
|
ProvisionedThroughput |
getProvisionedThroughput()
Represents the provisioned throughput settings for a specified table
or index.
|
int |
hashCode() |
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
(
HASH or RANGE ). |
void |
setProjection(Projection projection)
Represents attributes that are copied (projected) from the table into
an index.
|
void |
setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for a specified table
or index.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GlobalSecondaryIndex |
withIndexName(String indexName)
The name of the global secondary index.
|
GlobalSecondaryIndex |
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 or RANGE ). |
GlobalSecondaryIndex |
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 or RANGE ). |
GlobalSecondaryIndex |
withProjection(Projection projection)
Represents attributes that are copied (projected) from the table into
an index.
|
GlobalSecondaryIndex |
withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for a specified table
or index.
|
public String getIndexName()
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
public void setIndexName(String indexName)
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
indexName
- The name of the global secondary index. The name must be unique among
all other indexes on this table.public GlobalSecondaryIndex withIndexName(String indexName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
indexName
- The name of the global secondary index. The name must be unique among
all other indexes on this table.public List<KeySchemaElement> getKeySchema()
HASH
or RANGE
).
Constraints:
Length: 1 - 2
HASH
or RANGE
).public void setKeySchema(Collection<KeySchemaElement> keySchema)
HASH
or RANGE
).
Constraints:
Length: 1 - 2
keySchema
- The complete key schema for a global secondary index, which consists
of one or more pairs of attribute names and key types
(HASH
or RANGE
).public GlobalSecondaryIndex withKeySchema(KeySchemaElement... keySchema)
HASH
or RANGE
).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2
keySchema
- The complete key schema for a global secondary index, which consists
of one or more pairs of attribute names and key types
(HASH
or RANGE
).public GlobalSecondaryIndex withKeySchema(Collection<KeySchemaElement> keySchema)
HASH
or RANGE
).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2
keySchema
- The complete key schema for a global secondary index, which consists
of one or more pairs of attribute names and key types
(HASH
or RANGE
).public Projection getProjection()
public void setProjection(Projection projection)
projection
- Represents attributes that are copied (projected) from the table into
an index. These are in addition to the primary key attributes and
index key attributes, which are automatically projected.public GlobalSecondaryIndex withProjection(Projection projection)
Returns a reference to this object so that method calls can be chained together.
projection
- Represents attributes that are copied (projected) from the table into
an index. These are in addition to the primary key attributes and
index key attributes, which are automatically projected.public ProvisionedThroughput getProvisionedThroughput()
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
provisionedThroughput
- Represents the provisioned throughput settings for a specified table
or index. The settings can be modified using the UpdateTable
operation. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
public GlobalSecondaryIndex withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
provisionedThroughput
- Represents the provisioned throughput settings for a specified table
or index. The settings can be modified using the UpdateTable
operation. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
public String toString()
toString
in class Object
Object.toString()
public GlobalSecondaryIndex clone()
Copyright © 2015. All rights reserved.