PartitionIndexDescriptor (AWS Java SDK for AWS Glue 1.12.92 API)

java.lang.Object
- com.amazonaws.services.glue.model.PartitionIndexDescriptor

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

A descriptor for a partition index in a table.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PartitionIndexDescriptor()

Constructors
Constructor and Description
`PartitionIndexDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PartitionIndexDescriptor`	`clone()`
`boolean`	`equals(Object obj)`
`List<BackfillError>`	`getBackfillErrors()` A list of errors that can occur when registering partition indexes for an existing table.
`String`	`getIndexName()` The name of the partition index.
`String`	`getIndexStatus()` The status of the partition index.
`List<KeySchemaElement>`	`getKeys()` A list of one or more keys, as `KeySchemaElement` structures, for the partition index.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setBackfillErrors(Collection<BackfillError> backfillErrors)` A list of errors that can occur when registering partition indexes for an existing table.
`void`	`setIndexName(String indexName)` The name of the partition index.
`void`	`setIndexStatus(String indexStatus)` The status of the partition index.
`void`	`setKeys(Collection<KeySchemaElement> keys)` A list of one or more keys, as `KeySchemaElement` structures, for the partition index.
`String`	`toString()` Returns a string representation of this object.
`PartitionIndexDescriptor`	`withBackfillErrors(BackfillError... backfillErrors)` A list of errors that can occur when registering partition indexes for an existing table.
`PartitionIndexDescriptor`	`withBackfillErrors(Collection<BackfillError> backfillErrors)` A list of errors that can occur when registering partition indexes for an existing table.
`PartitionIndexDescriptor`	`withIndexName(String indexName)` The name of the partition index.
`PartitionIndexDescriptor`	`withIndexStatus(PartitionIndexStatus indexStatus)` The status of the partition index.
`PartitionIndexDescriptor`	`withIndexStatus(String indexStatus)` The status of the partition index.
`PartitionIndexDescriptor`	`withKeys(Collection<KeySchemaElement> keys)` A list of one or more keys, as `KeySchemaElement` structures, for the partition index.
`PartitionIndexDescriptor`	`withKeys(KeySchemaElement... keys)` A list of one or more keys, as `KeySchemaElement` structures, for the partition index.

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

- Constructor Detail
  - PartitionIndexDescriptor
```
public PartitionIndexDescriptor()
```
- Method Detail
  - setIndexName
```
public void setIndexName(String indexName)
```
    The name of the partition index.
    
    Parameters:
    
    indexName - The name of the partition index.
  - getIndexName
```
public String getIndexName()
```
    The name of the partition index.
    
    Returns:
    
    The name of the partition index.
  - withIndexName
```
public PartitionIndexDescriptor withIndexName(String indexName)
```
    The name of the partition index.
    
    Parameters:
    
    indexName - The name of the partition index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getKeys
```
public List<KeySchemaElement> getKeys()
```
    A list of one or more keys, as KeySchemaElement structures, for the partition index.
    
    Returns:
    
    A list of one or more keys, as KeySchemaElement structures, for the partition index.
  - setKeys
```
public void setKeys(Collection<KeySchemaElement> keys)
```
    A list of one or more keys, as KeySchemaElement structures, for the partition index.
    
    Parameters:
    
    keys - A list of one or more keys, as KeySchemaElement structures, for the partition index.
  - withKeys
```
public PartitionIndexDescriptor withKeys(KeySchemaElement... keys)
```
    A list of one or more keys, as KeySchemaElement structures, for the partition index.
    
    NOTE: This method appends the values to the existing list (if any). Use setKeys(java.util.Collection) or withKeys(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    keys - A list of one or more keys, as KeySchemaElement structures, for the partition index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withKeys
```
public PartitionIndexDescriptor withKeys(Collection<KeySchemaElement> keys)
```
    A list of one or more keys, as KeySchemaElement structures, for the partition index.
    
    Parameters:
    
    keys - A list of one or more keys, as KeySchemaElement structures, for the partition index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexStatus
```
public void setIndexStatus(String 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.
    Parameters:
    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.
    See Also:
    
    PartitionIndexStatus
  - getIndexStatus
```
public String getIndexStatus()
```
    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.
    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
  - withIndexStatus
```
public PartitionIndexDescriptor withIndexStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PartitionIndexStatus
  - withIndexStatus
```
public PartitionIndexDescriptor withIndexStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PartitionIndexStatus
  - getBackfillErrors
```
public List<BackfillError> getBackfillErrors()
```
    A list of errors that can occur when registering partition indexes for an existing table.
    
    Returns:
    
    A list of errors that can occur when registering partition indexes for an existing table.
  - setBackfillErrors
```
public void setBackfillErrors(Collection<BackfillError> backfillErrors)
```
    A list of errors that can occur when registering partition indexes for an existing table.
    
    Parameters:
    
    backfillErrors - A list of errors that can occur when registering partition indexes for an existing table.
  - withBackfillErrors
```
public PartitionIndexDescriptor withBackfillErrors(BackfillError... backfillErrors)
```
    A list of errors that can occur when registering partition indexes for an existing table.
    
    NOTE: This method appends the values to the existing list (if any). Use setBackfillErrors(java.util.Collection) or withBackfillErrors(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    backfillErrors - A list of errors that can occur when registering partition indexes for an existing table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBackfillErrors
```
public PartitionIndexDescriptor withBackfillErrors(Collection<BackfillError> backfillErrors)
```
    A list of errors that can occur when registering partition indexes for an existing table.
    
    Parameters:
    
    backfillErrors - A list of errors that can occur when registering partition indexes for an existing table.
    
    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 PartitionIndexDescriptor clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class PartitionIndexDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PartitionIndexDescriptor

Method Detail

setIndexName

getIndexName

withIndexName

getKeys

setKeys

withKeys

withKeys

setIndexStatus

getIndexStatus

withIndexStatus

withIndexStatus

getBackfillErrors

setBackfillErrors

withBackfillErrors

withBackfillErrors

toString

equals

hashCode

clone

marshall