com.amazonaws.services.cloudsearch.model

Class OptionStatus

java.lang.Object

com.amazonaws.services.cloudsearch.model.OptionStatus

All Implemented Interfaces:

Serializable

public class OptionStatus
extends Object
implements Serializable

The status of an option, including when it was last updated and whether it is actively in use for searches.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OptionStatus()

Method Summary

Methods

Modifier and Type	Method and Description
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

getCreationDate

public Date getCreationDate()

A timestamp for when this option was created.

Returns:

A timestamp for when this option was created.

setCreationDate

public void setCreationDate(Date creationDate)

A timestamp for when this option was created.

Parameters:

creationDate - A timestamp for when this option was created.

withCreationDate

public OptionStatus withCreationDate(Date creationDate)

A timestamp for when this option was created.

Returns a reference to this object so that method calls can be chained together.

Parameters:

creationDate - A timestamp for when this option was created.

Returns:

A reference to this updated object so that method calls can be chained together.

getUpdateDate

public Date getUpdateDate()

A timestamp for when this option was last updated.

Returns:

A timestamp for when this option was last updated.

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.

withUpdateDate

public OptionStatus withUpdateDate(Date updateDate)

A timestamp for when this option was last updated.

Returns a reference to this object so that method calls can be chained together.

Parameters:

updateDate - A timestamp for when this option was last updated.

Returns:

A reference to this updated object so that method calls can be chained together.

getUpdateVersion

public Integer getUpdateVersion()

A unique integer that indicates when this option was last updated.

Constraints:
Range: 0 -

Returns:

A unique integer that indicates when this option was last updated.

setUpdateVersion

public void setUpdateVersion(Integer updateVersion)

A unique integer that indicates when this option was last updated.

Constraints:
Range: 0 -

Parameters:

updateVersion - 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

Parameters:

updateVersion - A unique integer that indicates when this option was last updated.

Returns:

A reference to this updated object so that method calls can be chained together.

getState

public String getState()

The state of processing a change to an option. Possible values:

• RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active

Returns:

The state of processing a change to an option. Possible values:

• RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

See Also:

OptionState

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 visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active

Parameters:

state - The state of processing a change to an option. Possible values:

• RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

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 visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active

Parameters:

state - The state of processing a change to an option. Possible values:

• RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

Returns:

A reference to this updated 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 visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active

Parameters:

state - The state of processing a change to an option. Possible values:

• RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

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 visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active

Parameters:

state - The state of processing a change to an option. Possible values:

• RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
• Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
• Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

OptionState

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.

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.

withPendingDeletion

public OptionStatus withPendingDeletion(Boolean pendingDeletion)

Indicates that the option will be deleted once processing is complete.

Returns a reference to this object so that method calls can be chained together.

Parameters:

pendingDeletion - Indicates that the option will be deleted once processing is complete.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object