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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionId
protected java.util.Date	created
protected java.lang.String	description
protected java.lang.String	documentId
protected java.lang.String	noticeId
protected java.lang.String	queryId
protected java.lang.String	severity
protected java.lang.String	step

Constructor Summary

Constructors

Constructor and Description
Notice()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCollectionId() Gets the collectionId.
java.util.Date	getCreated() Gets the created.
java.lang.String	getDescription() Gets the description.
java.lang.String	getDocumentId() Gets the documentId.
java.lang.String	getNoticeId() Gets the noticeId.
java.lang.String	getQueryId() Gets the queryId.
java.lang.String	getSeverity() Gets the severity.
java.lang.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noticeId

@SerializedName(value="notice_id")
protected java.lang.String noticeId

created

protected java.util.Date created

documentId

@SerializedName(value="document_id")
protected java.lang.String documentId

collectionId

@SerializedName(value="collection_id")
protected java.lang.String collectionId

queryId

@SerializedName(value="query_id")
protected java.lang.String queryId

severity

protected java.lang.String severity

step

protected java.lang.String step

description

protected java.lang.String description

Constructor Detail

Notice

public Notice()

Method Detail

getNoticeId

public java.lang.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 java.util.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 java.lang.String getDocumentId()

Gets the documentId.

Unique identifier of the document.

Returns:

the documentId

getCollectionId

public java.lang.String getCollectionId()

Gets the collectionId.

Unique identifier of the collection.

Returns:

the collectionId

getQueryId

public java.lang.String getQueryId()

Gets the queryId.

Unique identifier of the query used for relevance training.

Returns:

the queryId

getSeverity

public java.lang.String getSeverity()

Gets the severity.

Severity level of the notice.

Returns:

the severity

getStep

public java.lang.String getStep()

Gets the step.

Ingestion or training step in which the notice occurred.

Returns:

the step

getDescription

public java.lang.String getDescription()

Gets the description.

The description of the notice.

Returns:

the description