Interface OptionStatus.Builder

  • Method Details

    • creationDate

      OptionStatus.Builder creationDate(Instant 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.
    • updateDate

      OptionStatus.Builder updateDate(Instant 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.
    • updateVersion

      OptionStatus.Builder updateVersion(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.
    • 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:
    • 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:
    • pendingDeletion

      OptionStatus.Builder pendingDeletion(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.