PartitionIndexDescriptor (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.glue.model.PartitionIndexDescriptor

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<PartitionIndexDescriptor.Builder,PartitionIndexDescriptor>

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

A descriptor for a partition index in a table.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PartitionIndexDescriptor.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PartitionIndexDescriptor.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<BackfillError>`	`backfillErrors()` A list of errors that can occur when registering partition indexes for an existing table.
`static PartitionIndexDescriptor.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBackfillErrors()` For responses, this returns true if the service returned a value for the BackfillErrors property.
`int`	`hashCode()`
`boolean`	`hasKeys()` For responses, this returns true if the service returned a value for the Keys property.
`String`	`indexName()` The name of the partition index.
`PartitionIndexStatus`	`indexStatus()` The status of the partition index.
`String`	`indexStatusAsString()` The status of the partition index.
`List<KeySchemaElement>`	`keys()` A list of one or more keys, as `KeySchemaElement` structures, for the partition index.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PartitionIndexDescriptor.Builder>`	`serializableBuilderClass()`
`PartitionIndexDescriptor.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
  - indexName
```
public final String indexName()
```
    The name of the partition index.
    
    Returns:
    
    The name of the partition index.
  - hasKeys
```
public final boolean hasKeys()
```
    For responses, this returns true if the service returned a value for the Keys 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.
  - keys
```
public final List<KeySchemaElement> keys()
```
    A list of one or more keys, as KeySchemaElement structures, for the partition 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 hasKeys() method.
    
    Returns:
    
    A list of one or more keys, as KeySchemaElement structures, for the partition index.
  - indexStatus
```
public final PartitionIndexStatus indexStatus()
```
    The status of the partition index.
    
    The possible statuses are:
    - CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
    - ACTIVE: The index creation succeeds.
    - FAILED: The index creation fails.
    - DELETING: The index is deleted from the list of indexes.
    If the service returns an enum value that is not available in the current SDK version, indexStatus will return PartitionIndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().
    Returns:
    The status of the partition index.
    
    The possible statuses are:
    
    CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
    
    ACTIVE: The index creation succeeds.
    
    FAILED: The index creation fails.
    
    DELETING: The index is deleted from the list of indexes.
    See Also:
    
    PartitionIndexStatus
  - indexStatusAsString
```
public final String indexStatusAsString()
```
    The status of the partition index.
    
    The possible statuses are:
    - CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
    - ACTIVE: The index creation succeeds.
    - FAILED: The index creation fails.
    - DELETING: The index is deleted from the list of indexes.
    If the service returns an enum value that is not available in the current SDK version, indexStatus will return PartitionIndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().
    Returns:
    The status of the partition index.
    
    The possible statuses are:
    
    CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
    
    ACTIVE: The index creation succeeds.
    
    FAILED: The index creation fails.
    
    DELETING: The index is deleted from the list of indexes.
    See Also:
    
    PartitionIndexStatus
  - hasBackfillErrors
```
public final boolean hasBackfillErrors()
```
    For responses, this returns true if the service returned a value for the BackfillErrors 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.
  - backfillErrors
```
public final List<BackfillError> backfillErrors()
```
    A list of errors that can occur when registering partition indexes for an existing table.
    
    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 hasBackfillErrors() method.
    
    Returns:
    
    A list of errors that can occur when registering partition indexes for an existing table.
  - toBuilder
```
public PartitionIndexDescriptor.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PartitionIndexDescriptor.Builder,PartitionIndexDescriptor>
  - builder
```
public static PartitionIndexDescriptor.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PartitionIndexDescriptor.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

Class PartitionIndexDescriptor

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

indexName

hasKeys

keys

indexStatus

indexStatusAsString

hasBackfillErrors

backfillErrors

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields