AwsDynamoDbTableGlobalSecondaryIndex (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsDynamoDbTableGlobalSecondaryIndex

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsDynamoDbTableGlobalSecondaryIndex
extends Object
implements Serializable, Cloneable, StructuredPojo

Information abut a global secondary index for the table.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsDynamoDbTableGlobalSecondaryIndex()

Constructors
Constructor and Description
`AwsDynamoDbTableGlobalSecondaryIndex()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsDynamoDbTableGlobalSecondaryIndex`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getBackfilling()` Whether the index is currently backfilling.
`String`	`getIndexArn()` The ARN of the index.
`String`	`getIndexName()` The name of the index.
`Long`	`getIndexSizeBytes()` The total size in bytes of the index.
`String`	`getIndexStatus()` The current status of the index.
`Integer`	`getItemCount()` The number of items in the index.
`List<AwsDynamoDbTableKeySchema>`	`getKeySchema()` The key schema for the index.
`AwsDynamoDbTableProjection`	`getProjection()` Attributes that are copied from the table into an index.
`AwsDynamoDbTableProvisionedThroughput`	`getProvisionedThroughput()` Information about the provisioned throughput settings for the indexes.
`int`	`hashCode()`
`Boolean`	`isBackfilling()` Whether the index is currently backfilling.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBackfilling(Boolean backfilling)` Whether the index is currently backfilling.
`void`	`setIndexArn(String indexArn)` The ARN of the index.
`void`	`setIndexName(String indexName)` The name of the index.
`void`	`setIndexSizeBytes(Long indexSizeBytes)` The total size in bytes of the index.
`void`	`setIndexStatus(String indexStatus)` The current status of the index.
`void`	`setItemCount(Integer itemCount)` The number of items in the index.
`void`	`setKeySchema(Collection<AwsDynamoDbTableKeySchema> keySchema)` The key schema for the index.
`void`	`setProjection(AwsDynamoDbTableProjection projection)` Attributes that are copied from the table into an index.
`void`	`setProvisionedThroughput(AwsDynamoDbTableProvisionedThroughput provisionedThroughput)` Information about the provisioned throughput settings for the indexes.
`String`	`toString()` Returns a string representation of this object.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withBackfilling(Boolean backfilling)` Whether the index is currently backfilling.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withIndexArn(String indexArn)` The ARN of the index.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withIndexName(String indexName)` The name of the index.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withIndexSizeBytes(Long indexSizeBytes)` The total size in bytes of the index.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withIndexStatus(String indexStatus)` The current status of the index.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withItemCount(Integer itemCount)` The number of items in the index.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withKeySchema(AwsDynamoDbTableKeySchema... keySchema)` The key schema for the index.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withKeySchema(Collection<AwsDynamoDbTableKeySchema> keySchema)` The key schema for the index.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withProjection(AwsDynamoDbTableProjection projection)` Attributes that are copied from the table into an index.
`AwsDynamoDbTableGlobalSecondaryIndex`	`withProvisionedThroughput(AwsDynamoDbTableProvisionedThroughput provisionedThroughput)` Information about the provisioned throughput settings for the indexes.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AwsDynamoDbTableGlobalSecondaryIndex
```
public AwsDynamoDbTableGlobalSecondaryIndex()
```
- Method Detail
  - setBackfilling
```
public void setBackfilling(Boolean backfilling)
```
    Whether the index is currently backfilling.
    
    Parameters:
    
    backfilling - Whether the index is currently backfilling.
  - getBackfilling
```
public Boolean getBackfilling()
```
    Whether the index is currently backfilling.
    
    Returns:
    
    Whether the index is currently backfilling.
  - withBackfilling
```
public AwsDynamoDbTableGlobalSecondaryIndex withBackfilling(Boolean backfilling)
```
    Whether the index is currently backfilling.
    
    Parameters:
    
    backfilling - Whether the index is currently backfilling.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isBackfilling
```
public Boolean isBackfilling()
```
    Whether the index is currently backfilling.
    
    Returns:
    
    Whether the index is currently backfilling.
  - setIndexArn
```
public void setIndexArn(String indexArn)
```
    The ARN of the index.
    
    Parameters:
    
    indexArn - The ARN of the index.
  - getIndexArn
```
public String getIndexArn()
```
    The ARN of the index.
    
    Returns:
    
    The ARN of the index.
  - withIndexArn
```
public AwsDynamoDbTableGlobalSecondaryIndex withIndexArn(String indexArn)
```
    The ARN of the index.
    
    Parameters:
    
    indexArn - The ARN of the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexName
```
public void setIndexName(String indexName)
```
    The name of the index.
    
    Parameters:
    
    indexName - The name of the index.
  - getIndexName
```
public String getIndexName()
```
    The name of the index.
    
    Returns:
    
    The name of the index.
  - withIndexName
```
public AwsDynamoDbTableGlobalSecondaryIndex withIndexName(String indexName)
```
    The name of the index.
    
    Parameters:
    
    indexName - The name of the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexSizeBytes
```
public void setIndexSizeBytes(Long indexSizeBytes)
```
    The total size in bytes of the index.
    
    Parameters:
    
    indexSizeBytes - The total size in bytes of the index.
  - getIndexSizeBytes
```
public Long getIndexSizeBytes()
```
    The total size in bytes of the index.
    
    Returns:
    
    The total size in bytes of the index.
  - withIndexSizeBytes
```
public AwsDynamoDbTableGlobalSecondaryIndex withIndexSizeBytes(Long indexSizeBytes)
```
    The total size in bytes of the index.
    
    Parameters:
    
    indexSizeBytes - The total size in bytes of the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexStatus
```
public void setIndexStatus(String indexStatus)
```
    The current status of the index.
    
    Parameters:
    
    indexStatus - The current status of the index.
  - getIndexStatus
```
public String getIndexStatus()
```
    The current status of the index.
    
    Returns:
    
    The current status of the index.
  - withIndexStatus
```
public AwsDynamoDbTableGlobalSecondaryIndex withIndexStatus(String indexStatus)
```
    The current status of the index.
    
    Parameters:
    
    indexStatus - The current status of the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setItemCount
```
public void setItemCount(Integer itemCount)
```
    The number of items in the index.
    
    Parameters:
    
    itemCount - The number of items in the index.
  - getItemCount
```
public Integer getItemCount()
```
    The number of items in the index.
    
    Returns:
    
    The number of items in the index.
  - withItemCount
```
public AwsDynamoDbTableGlobalSecondaryIndex withItemCount(Integer itemCount)
```
    The number of items in the index.
    
    Parameters:
    
    itemCount - The number of items in the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getKeySchema
```
public List<AwsDynamoDbTableKeySchema> getKeySchema()
```
    The key schema for the index.
    
    Returns:
    
    The key schema for the index.
  - setKeySchema
```
public void setKeySchema(Collection<AwsDynamoDbTableKeySchema> keySchema)
```
    The key schema for the index.
    
    Parameters:
    
    keySchema - The key schema for the index.
  - withKeySchema
```
public AwsDynamoDbTableGlobalSecondaryIndex withKeySchema(AwsDynamoDbTableKeySchema... keySchema)
```
    The key schema for the index.
    
    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.
    
    Parameters:
    
    keySchema - The key schema for the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withKeySchema
```
public AwsDynamoDbTableGlobalSecondaryIndex withKeySchema(Collection<AwsDynamoDbTableKeySchema> keySchema)
```
    The key schema for the index.
    
    Parameters:
    
    keySchema - The key schema for the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProjection
```
public void setProjection(AwsDynamoDbTableProjection projection)
```
    Attributes that are copied from the table into an index.
    
    Parameters:
    
    projection - Attributes that are copied from the table into an index.
  - getProjection
```
public AwsDynamoDbTableProjection getProjection()
```
    Attributes that are copied from the table into an index.
    
    Returns:
    
    Attributes that are copied from the table into an index.
  - withProjection
```
public AwsDynamoDbTableGlobalSecondaryIndex withProjection(AwsDynamoDbTableProjection projection)
```
    Attributes that are copied from the table into an index.
    
    Parameters:
    
    projection - Attributes that are copied from the table into an index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProvisionedThroughput
```
public void setProvisionedThroughput(AwsDynamoDbTableProvisionedThroughput provisionedThroughput)
```
    Information about the provisioned throughput settings for the indexes.
    
    Parameters:
    
    provisionedThroughput - Information about the provisioned throughput settings for the indexes.
  - getProvisionedThroughput
```
public AwsDynamoDbTableProvisionedThroughput getProvisionedThroughput()
```
    Information about the provisioned throughput settings for the indexes.
    
    Returns:
    
    Information about the provisioned throughput settings for the indexes.
  - withProvisionedThroughput
```
public AwsDynamoDbTableGlobalSecondaryIndex withProvisionedThroughput(AwsDynamoDbTableProvisionedThroughput provisionedThroughput)
```
    Information about the provisioned throughput settings for the indexes.
    
    Parameters:
    
    provisionedThroughput - Information about the provisioned throughput settings for the indexes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AwsDynamoDbTableGlobalSecondaryIndex clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AwsDynamoDbTableGlobalSecondaryIndex

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsDynamoDbTableGlobalSecondaryIndex

Method Detail

setBackfilling

getBackfilling

withBackfilling

isBackfilling

setIndexArn

getIndexArn

withIndexArn

setIndexName

getIndexName

withIndexName

setIndexSizeBytes

getIndexSizeBytes

withIndexSizeBytes

setIndexStatus

getIndexStatus

withIndexStatus

setItemCount

getItemCount

withItemCount

getKeySchema

setKeySchema

withKeySchema

withKeySchema

setProjection

getProjection

withProjection

setProvisionedThroughput

getProvisionedThroughput

withProvisionedThroughput

toString

equals

hashCode

clone

marshall