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

Class EnrichmentOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.EnrichmentOptions

All Implemented Interfaces:

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

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

An object that contains options for the current enrichment. Starting with version `2020-08-30`, the enrichment options are not included in responses from the List Enrichments method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnrichmentOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	entityType()	Gets the entityType.
List<String>	languages()	Gets the languages.
EnrichmentOptions.Builder	newBuilder()	New builder.
String	regularExpression()	Gets the regularExpression.
String	resultField()	Gets the resultField.

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 Details

newBuilder

public EnrichmentOptions.Builder newBuilder()

New builder.

Returns:

a EnrichmentOptions builder

languages

public List<String> languages()

Gets the languages.

An array of supported languages for this enrichment. Required when `type` is `dictionary`. Optional when `type` is `rule_based`. Not valid when creating any other type of enrichment.

Returns:

the languages

entityType

public String entityType()

Gets the entityType.

The name of the entity type. This value is used as the field name in the index. Required when `type` is `dictionary` or `regular_expression`. Not valid when creating any other type of enrichment.

Returns:

the entityType

regularExpression

public String regularExpression()

Gets the regularExpression.

The regular expression to apply for this enrichment. Required when `type` is `regular_expression`. Not valid when creating any other type of enrichment.

Returns:

the regularExpression

resultField

public String resultField()

Gets the resultField.

The name of the result document field that this enrichment creates. Required when `type` is `rule_based`. Not valid when creating any other type of enrichment.

Returns:

the resultField