Interface Status.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Status.Builder,Status>, SdkBuilder<Status.Builder,Status>, SdkPojo
Enclosing class:
Status

public static interface Status.Builder extends SdkPojo, CopyableBuilder<Status.Builder,Status>
  • Method Details

    • documentId

      Status.Builder documentId(String documentId)

      The identifier of the document.

      Parameters:
      documentId - The identifier of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • documentStatus

      Status.Builder documentStatus(String documentStatus)

      The current status of a document.

      If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

      Parameters:
      documentStatus - The current status of a document.

      If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • documentStatus

      Status.Builder documentStatus(DocumentStatus documentStatus)

      The current status of a document.

      If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

      Parameters:
      documentStatus - The current status of a document.

      If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • failureCode

      Status.Builder failureCode(String failureCode)

      Indicates the source of the error.

      Parameters:
      failureCode - Indicates the source of the error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • failureReason

      Status.Builder failureReason(String failureReason)

      Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

      Parameters:
      failureReason - Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.