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

A object containing options for the current enrichment.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	entityType
protected java.util.List<java.lang.String>	languages
protected java.lang.String	regularExpression
protected java.lang.String	resultField

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnrichmentOptions(EnrichmentOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	entityType() Gets the entityType.
java.util.List<java.lang.String>	languages() Gets the languages.
EnrichmentOptions.Builder	newBuilder() New builder.
java.lang.String	regularExpression() Gets the regularExpression.
java.lang.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

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

Field Detail

languages

protected java.util.List<java.lang.String> languages

entityType

@SerializedName(value="entity_type")
protected java.lang.String entityType

regularExpression

@SerializedName(value="regular_expression")
protected java.lang.String regularExpression

resultField

@SerializedName(value="result_field")
protected java.lang.String resultField

Constructor Detail

EnrichmentOptions

protected EnrichmentOptions(EnrichmentOptions.Builder builder)

Method Detail

newBuilder

public EnrichmentOptions.Builder newBuilder()

New builder.

Returns:

a EnrichmentOptions builder

languages

public java.util.List<java.lang.String> languages()

Gets the languages.

An array of supported languages for this enrichment.

Returns:

the languages

entityType

public java.lang.String entityType()

Gets the entityType.

The type of entity. Required when creating `dictionary` and `regular_expression` **type** enrichment. Not valid when creating any other type of enrichment.

Returns:

the entityType

regularExpression

public java.lang.String regularExpression()

Gets the regularExpression.

The regular expression to apply for this enrichment. Required only when the **type** of enrichment being created is a `regular_expression`. Not valid when creating any other type of enrichment.

Returns:

the regularExpression

resultField

public java.lang.String resultField()

Gets the resultField.

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

Returns:

the resultField