com.ibm.watson.discovery.v1.model

Class Notice

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.discovery.v1.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Notice.Severity Severity level of the notice.

Method Summary

Modifier and Type	Method and Description
Date	getCreated() Gets the created.
String	getDescription() Gets the description.
String	getDocumentId() Gets the documentId.
String	getNoticeId() Gets the noticeId.
String	getQueryId() Gets the queryId.
String	getSeverity() Gets the severity.
String	getStep() Gets the step.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

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

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. Typical step values include: `smartDocumentUnderstanding`, `ingestion`, `indexing`, `convert`. **Note:** This is not a complete list; other values might be returned.

Returns:

the step

getDescription

public String getDescription()

Gets the description.

The description of the notice.

Returns:

the description