OptionStatus (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudsearchv2.model.OptionStatus

All Implemented Interfaces:: Serializable, Cloneable

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

The status of domain configuration option.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

OptionStatus()

Constructors
Constructor and Description
`OptionStatus()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OptionStatus`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationDate()` A timestamp for when this option was created.
`Boolean`	`getPendingDeletion()` Indicates that the option will be deleted once processing is complete.
`String`	`getState()` The state of processing a change to an option.
`Date`	`getUpdateDate()` A timestamp for when this option was last updated.
`Integer`	`getUpdateVersion()` A unique integer that indicates when this option was last updated.
`int`	`hashCode()`
`Boolean`	`isPendingDeletion()` Indicates that the option will be deleted once processing is complete.
`void`	`setCreationDate(Date creationDate)` A timestamp for when this option was created.
`void`	`setPendingDeletion(Boolean pendingDeletion)` Indicates that the option will be deleted once processing is complete.
`void`	`setState(OptionState state)` The state of processing a change to an option.
`void`	`setState(String state)` The state of processing a change to an option.
`void`	`setUpdateDate(Date updateDate)` A timestamp for when this option was last updated.
`void`	`setUpdateVersion(Integer updateVersion)` A unique integer that indicates when this option was last updated.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`OptionStatus`	`withCreationDate(Date creationDate)` A timestamp for when this option was created.
`OptionStatus`	`withPendingDeletion(Boolean pendingDeletion)` Indicates that the option will be deleted once processing is complete.
`OptionStatus`	`withState(OptionState state)` The state of processing a change to an option.
`OptionStatus`	`withState(String state)` The state of processing a change to an option.
`OptionStatus`	`withUpdateDate(Date updateDate)` A timestamp for when this option was last updated.
`OptionStatus`	`withUpdateVersion(Integer updateVersion)` A unique integer that indicates when this option was last updated.

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

- Constructor Detail
  - OptionStatus
```
public OptionStatus()
```
- Method Detail
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    A timestamp for when this option was created.
    
    Parameters:
    
    creationDate - A timestamp for when this option was created.
  - getCreationDate
```
public Date getCreationDate()
```
    A timestamp for when this option was created.
    
    Returns:
    
    A timestamp for when this option was created.
  - withCreationDate
```
public OptionStatus withCreationDate(Date creationDate)
```
    A timestamp for when this option was created.
    
    Parameters:
    
    creationDate - A timestamp for when this option was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdateDate
```
public void setUpdateDate(Date updateDate)
```
    A timestamp for when this option was last updated.
    
    Parameters:
    
    updateDate - A timestamp for when this option was last updated.
  - getUpdateDate
```
public Date getUpdateDate()
```
    A timestamp for when this option was last updated.
    
    Returns:
    
    A timestamp for when this option was last updated.
  - withUpdateDate
```
public OptionStatus withUpdateDate(Date updateDate)
```
    A timestamp for when this option was last updated.
    
    Parameters:
    
    updateDate - A timestamp for when this option was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdateVersion
```
public void setUpdateVersion(Integer updateVersion)
```
    A unique integer that indicates when this option was last updated.
    
    Parameters:
    
    updateVersion - A unique integer that indicates when this option was last updated.
  - getUpdateVersion
```
public Integer getUpdateVersion()
```
    A unique integer that indicates when this option was last updated.
    
    Returns:
    
    A unique integer that indicates when this option was last updated.
  - withUpdateVersion
```
public OptionStatus withUpdateVersion(Integer updateVersion)
```
    A unique integer that indicates when this option was last updated.
    
    Parameters:
    
    updateVersion - A unique integer that indicates when this option was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The state of processing a change to an option. Possible values:
    - RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    - Processing: the option's latest value is in the process of being activated.
    - Active: the option's latest value is completely deployed.
    - FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    Parameters:
    state - The state of processing a change to an option. Possible values:
    
    RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    
    Processing: the option's latest value is in the process of being activated.
    
    Active: the option's latest value is completely deployed.
    
    FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    See Also:
    
    OptionState
  - getState
```
public String getState()
```
    The state of processing a change to an option. Possible values:
    - RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    - Processing: the option's latest value is in the process of being activated.
    - Active: the option's latest value is completely deployed.
    - FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    Returns:
    The state of processing a change to an option. Possible values:
    
    RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    
    Processing: the option's latest value is in the process of being activated.
    
    Active: the option's latest value is completely deployed.
    
    FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    See Also:
    
    OptionState
  - withState
```
public OptionStatus withState(String state)
```
    The state of processing a change to an option. Possible values:
    - RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    - Processing: the option's latest value is in the process of being activated.
    - Active: the option's latest value is completely deployed.
    - FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    Parameters:
    state - The state of processing a change to an option. Possible values:
    
    RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    
    Processing: the option's latest value is in the process of being activated.
    
    Active: the option's latest value is completely deployed.
    
    FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OptionState
  - setState
```
public void setState(OptionState state)
```
    The state of processing a change to an option. Possible values:
    - RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    - Processing: the option's latest value is in the process of being activated.
    - Active: the option's latest value is completely deployed.
    - FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    Parameters:
    state - The state of processing a change to an option. Possible values:
    
    RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    
    Processing: the option's latest value is in the process of being activated.
    
    Active: the option's latest value is completely deployed.
    
    FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    See Also:
    
    OptionState
  - withState
```
public OptionStatus withState(OptionState state)
```
    The state of processing a change to an option. Possible values:
    - RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    - Processing: the option's latest value is in the process of being activated.
    - Active: the option's latest value is completely deployed.
    - FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    Parameters:
    state - The state of processing a change to an option. Possible values:
    
    RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    
    Processing: the option's latest value is in the process of being activated.
    
    Active: the option's latest value is completely deployed.
    
    FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OptionState
  - setPendingDeletion
```
public void setPendingDeletion(Boolean pendingDeletion)
```
    Indicates that the option will be deleted once processing is complete.
    
    Parameters:
    
    pendingDeletion - Indicates that the option will be deleted once processing is complete.
  - getPendingDeletion
```
public Boolean getPendingDeletion()
```
    Indicates that the option will be deleted once processing is complete.
    
    Returns:
    
    Indicates that the option will be deleted once processing is complete.
  - withPendingDeletion
```
public OptionStatus withPendingDeletion(Boolean pendingDeletion)
```
    Indicates that the option will be deleted once processing is complete.
    
    Parameters:
    
    pendingDeletion - Indicates that the option will be deleted once processing is complete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPendingDeletion
```
public Boolean isPendingDeletion()
```
    Indicates that the option will be deleted once processing is complete.
    
    Returns:
    
    Indicates that the option will be deleted once processing is complete.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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 OptionStatus clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class OptionStatus

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OptionStatus

Method Detail

setCreationDate

getCreationDate

withCreationDate

setUpdateDate

getUpdateDate

withUpdateDate

setUpdateVersion

getUpdateVersion

withUpdateVersion

setState

getState

withState

setState

withState

setPendingDeletion

getPendingDeletion

withPendingDeletion

isPendingDeletion

toString

equals

hashCode

clone