Package com.ibm.watson.discovery.v2.model

Class Notice

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.discovery.v2.model.Notice
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class Notice
extends com.ibm.cloud.sdk.core.service.model.GenericModel
A notice produced for the collection.

  • Constructor Details

    • Notice

      public Notice()

  • Method Details

    • getNoticeId

      public String getNoticeId()
      Gets the noticeId.

      Identifies the notice. Many notices might have the same ID. This field exists so that user applications can programmatically identify a notice and take automatic corrective action. Typical notice IDs include: `index_failed`, `index_failed_too_many_requests`, `index_failed_incompatible_field`, `index_failed_cluster_unavailable`, `ingestion_timeout`, `ingestion_error`, `bad_request`, `internal_error`, `missing_model`, `unsupported_model`, `smart_document_understanding_failed_incompatible_field`, `smart_document_understanding_failed_internal_error`, `smart_document_understanding_failed_internal_error`, `smart_document_understanding_failed_warning`, `smart_document_understanding_page_error`, `smart_document_understanding_page_warning`. **Note:** This is not a complete list, other values might be returned.

      Returns:
      the noticeId

    • getCreated

      public Date getCreated()
      Gets the created.

      The creation date of the collection in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

      Returns:
      the created

    • getDocumentId

      public String getDocumentId()
      Gets the documentId.

      Unique identifier of the document.

      Returns:
      the documentId

    • getCollectionId

      public String getCollectionId()
      Gets the collectionId.

      Unique identifier of the collection.

      Returns:
      the collectionId

    • getQueryId

      public String getQueryId()
      Gets the queryId.

      Unique identifier of the query used for relevance training.

      Returns:
      the queryId

    • getSeverity

      public String getSeverity()
      Gets the severity.

      Severity level of the notice.

      Returns:
      the severity

    • getStep

      public String getStep()
      Gets the step.

      Ingestion or training step in which the notice occurred.

      Returns:
      the step

    • getDescription

      public String getDescription()
      Gets the description.

      The description of the notice.

      Returns:
      the description