com.ibm.watson.discovery.v1.model

Class Enrichment

java.lang.Object

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

com.ibm.watson.discovery.v1.model.Enrichment

All Implemented Interfaces:

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

public class Enrichment
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Enrichment.

Constructor Summary

Constructors

Constructor and Description
Enrichment()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets the description.
java.lang.String	getDestinationField() Gets the destinationField.
java.lang.String	getEnrichmentName() Gets the enrichmentName.
EnrichmentOptions	getOptions() Gets the options.
java.lang.String	getSourceField() Gets the sourceField.
java.lang.Boolean	isIgnoreDownstreamErrors() Gets the ignoreDownstreamErrors.
java.lang.Boolean	isOverwrite() Gets the overwrite.
void	setDescription(java.lang.String description) Sets the description.
void	setDestinationField(java.lang.String destinationField) Sets the destinationField.
void	setEnrichmentName(java.lang.String enrichmentName) Sets the enrichmentName.
void	setIgnoreDownstreamErrors(java.lang.Boolean ignoreDownstreamErrors) Sets the ignoreDownstreamErrors.
void	setOptions(EnrichmentOptions options) Sets the options.
void	setOverwrite(java.lang.Boolean overwrite) Sets the overwrite.
void	setSourceField(java.lang.String sourceField) Sets the sourceField.

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

Constructor Detail

Enrichment

public Enrichment()

Method Detail

getDescription

public java.lang.String getDescription()

Gets the description. Describes what the enrichment step does.

Returns:

the description

getDestinationField

public java.lang.String getDestinationField()

Gets the destinationField. Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing field. For example, if `text` is a top-level field with no sub-fields, `text.foo` is a valid destination but `text.foo.bar` is not.

Returns:

the destinationField

getSourceField

public java.lang.String getSourceField()

Gets the sourceField. Field to be enriched. Arrays can be specified as the **source_field** if the **enrichment** service for this enrichment is set to `natural_language_undstanding`.

Returns:

the sourceField

isOverwrite

public java.lang.Boolean isOverwrite()

Gets the overwrite. Indicates that the enrichments will overwrite the destination_field field if it already exists.

Returns:

the overwrite

getEnrichmentName

public java.lang.String getEnrichmentName()

Gets the enrichmentName. Name of the enrichment service to call. Current options are `natural_language_understanding` and `elements`. When using `natual_language_understanding`, the **options** object must contain Natural Language Understanding options. When using `elements` the **options** object must contain Element Classification options. Additionally, when using the `elements` enrichment the configuration specified and files ingested must meet all the criteria specified in [the documentation] (https://cloud.ibm.com/docs/services/discovery?topic=discovery-element-classification#element-classification).

Returns:

the enrichmentName

isIgnoreDownstreamErrors

public java.lang.Boolean isIgnoreDownstreamErrors()

Gets the ignoreDownstreamErrors. If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the document to fail processing.

Returns:

the ignoreDownstreamErrors

getOptions

public EnrichmentOptions getOptions()

Gets the options. Options which are specific to a particular enrichment.

Returns:

the options

setDescription

public void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - the new description

setDestinationField

public void setDestinationField(java.lang.String destinationField)

Sets the destinationField.

Parameters:

destinationField - the new destinationField

setSourceField

public void setSourceField(java.lang.String sourceField)

Sets the sourceField.

Parameters:

sourceField - the new sourceField

setOverwrite

public void setOverwrite(java.lang.Boolean overwrite)

Sets the overwrite.

Parameters:

overwrite - the new overwrite

setEnrichmentName

public void setEnrichmentName(java.lang.String enrichmentName)

Sets the enrichmentName.

Parameters:

enrichmentName - the new enrichmentName

setIgnoreDownstreamErrors

public void setIgnoreDownstreamErrors(java.lang.Boolean ignoreDownstreamErrors)

Sets the ignoreDownstreamErrors.

Parameters:

ignoreDownstreamErrors - the new ignoreDownstreamErrors

setOptions

public void setOptions(EnrichmentOptions options)

Sets the options.

Parameters:

options - the new options