software.amazon.awssdk.services.securityhub.model

Class AwsDynamoDbTableGlobalSecondaryIndex

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsDynamoDbTableGlobalSecondaryIndex

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsDynamoDbTableGlobalSecondaryIndex.Builder,AwsDynamoDbTableGlobalSecondaryIndex>

@Generated(value="software.amazon.awssdk:codegen")
public final class AwsDynamoDbTableGlobalSecondaryIndex
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsDynamoDbTableGlobalSecondaryIndex.Builder,AwsDynamoDbTableGlobalSecondaryIndex>

Information abut a global secondary index for the table.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsDynamoDbTableGlobalSecondaryIndex.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	backfilling() Whether the index is currently backfilling.
static AwsDynamoDbTableGlobalSecondaryIndex.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	indexArn() The ARN of the index.
String	indexName() The name of the index.
Long	indexSizeBytes() The total size in bytes of the index.
String	indexStatus() The current status of the index.
Integer	itemCount() The number of items in the index.
List<AwsDynamoDbTableKeySchema>	keySchema() The key schema for the index.
AwsDynamoDbTableProjection	projection() Attributes that are copied from the table into an index.
AwsDynamoDbTableProvisionedThroughput	provisionedThroughput() Information about the provisioned throughput settings for the indexes.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsDynamoDbTableGlobalSecondaryIndex.Builder>	serializableBuilderClass()
AwsDynamoDbTableGlobalSecondaryIndex.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

backfilling

public final Boolean backfilling()

Whether the index is currently backfilling.

Returns:

Whether the index is currently backfilling.

indexArn

public final String indexArn()

The ARN of the index.

Returns:

The ARN of the index.

indexName

public final String indexName()

The name of the index.

Returns:

The name of the index.

indexSizeBytes

public final Long indexSizeBytes()

The total size in bytes of the index.

Returns:

The total size in bytes of the index.

indexStatus

public final String indexStatus()

The current status of the index.

• ACTIVE

• CREATING

• DELETING

• UPDATING

Returns:

The current status of the index.

• ACTIVE

• CREATING

• DELETING

• UPDATING

itemCount

public final Integer itemCount()

The number of items in the index.

Returns:

The number of items in the index.

hasKeySchema

public final boolean hasKeySchema()

For responses, this returns true if the service returned a value for the KeySchema property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

keySchema

public final List<AwsDynamoDbTableKeySchema> keySchema()

The key schema for the index.

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.

Returns:

The key schema for the index.

projection

public final AwsDynamoDbTableProjection projection()

Attributes that are copied from the table into an index.

Returns:

Attributes that are copied from the table into an index.

provisionedThroughput

public final AwsDynamoDbTableProvisionedThroughput provisionedThroughput()

Information about the provisioned throughput settings for the indexes.

Returns:

Information about the provisioned throughput settings for the indexes.

toBuilder

public AwsDynamoDbTableGlobalSecondaryIndex.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsDynamoDbTableGlobalSecondaryIndex.Builder,AwsDynamoDbTableGlobalSecondaryIndex>

builder

public static AwsDynamoDbTableGlobalSecondaryIndex.Builder builder()

serializableBuilderClass

public static Class<? extends AwsDynamoDbTableGlobalSecondaryIndex.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo