Class OptionStatus
- All Implemented Interfaces:
Serializable
,Cloneable
The status of domain configuration option.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
A timestamp for when this option was created.Indicates that the option will be deleted once processing is complete.getState()
The state of processing a change to an option.A timestamp for when this option was last updated.A unique integer that indicates when this option was last updated.int
hashCode()
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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withCreationDate
(Date creationDate) A timestamp for when this option was created.withPendingDeletion
(Boolean pendingDeletion) Indicates that the option will be deleted once processing is complete.withState
(OptionState state) The state of processing a change to an option.The state of processing a change to an option.withUpdateDate
(Date updateDate) A timestamp for when this option was last updated.withUpdateVersion
(Integer updateVersion) A unique integer that indicates when this option was last updated.
-
Constructor Details
-
OptionStatus
public OptionStatus()
-
-
Method Details
-
setCreationDate
A timestamp for when this option was created.
- Parameters:
creationDate
- A timestamp for when this option was created.
-
getCreationDate
A timestamp for when this option was created.
- Returns:
- A timestamp for when this option was created.
-
withCreationDate
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
A timestamp for when this option was last updated.
- Parameters:
updateDate
- A timestamp for when this option was last updated.
-
getUpdateDate
A timestamp for when this option was last updated.
- Returns:
- A timestamp for when this option was last updated.
-
withUpdateDate
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
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
A unique integer that indicates when this option was last updated.
- Returns:
- A unique integer that indicates when this option was last updated.
-
withUpdateVersion
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
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:
-
-
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:
-
-
withState
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:
-
-
setState
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:
-
-
withState
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:
-
-
setPendingDeletion
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
Indicates that the option will be deleted once processing is complete.
- Returns:
- Indicates that the option will be deleted once processing is complete.
-
withPendingDeletion
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
Indicates that the option will be deleted once processing is complete.
- Returns:
- Indicates that the option will be deleted once processing is complete.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-