public class OptionStatus extends Object implements Serializable, Cloneable
The status of domain configuration option.
Constructor and Description |
---|
OptionStatus() |
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.
|
public Date getCreationDate()
public void setCreationDate(Date creationDate)
creationDate
- A timestamp for when this option was created.public OptionStatus withCreationDate(Date creationDate)
Returns a reference to this object so that method calls can be chained together.
creationDate
- A timestamp for when this option was created.public Date getUpdateDate()
public void setUpdateDate(Date updateDate)
updateDate
- A timestamp for when this option was last updated.public OptionStatus withUpdateDate(Date updateDate)
Returns a reference to this object so that method calls can be chained together.
updateDate
- A timestamp for when this option was last updated.public Integer getUpdateVersion()
Constraints:
Range: 0 -
public void setUpdateVersion(Integer updateVersion)
Constraints:
Range: 0 -
updateVersion
- A unique integer that indicates when this option was last updated.public OptionStatus withUpdateVersion(Integer updateVersion)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 0 -
updateVersion
- A unique integer that indicates when this option was last updated.public String getState()
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.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active, FailedToValidate
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.OptionState
public void setState(String state)
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.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active, FailedToValidate
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.OptionState
public OptionStatus withState(String state)
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 a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active, FailedToValidate
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.OptionState
public void setState(OptionState state)
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.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active, FailedToValidate
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.OptionState
public OptionStatus withState(OptionState state)
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 a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active, FailedToValidate
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.OptionState
public Boolean isPendingDeletion()
public void setPendingDeletion(Boolean pendingDeletion)
pendingDeletion
- Indicates that the option will be deleted once processing is complete.public OptionStatus withPendingDeletion(Boolean pendingDeletion)
Returns a reference to this object so that method calls can be chained together.
pendingDeletion
- Indicates that the option will be deleted once processing is complete.public Boolean getPendingDeletion()
public String toString()
toString
in class Object
Object.toString()
public OptionStatus clone()
Copyright © 2015. All rights reserved.