com.ibm.watson.health.iml.v1.model

Class GetCuiInfoOptions

java.lang.Object

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

com.ibm.watson.health.iml.v1.model.GetCuiInfoOptions

All Implemented Interfaces:

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

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

The getCuiInfo options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	corpus() Gets the corpus.
String	fields() Gets the fields.
String	nameOrId() Gets the nameOrId.
GetCuiInfoOptions.Builder	newBuilder() New builder.
String	ontology() Gets the ontology.
Boolean	treeLayout() Gets the treeLayout.

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

newBuilder

public GetCuiInfoOptions.Builder newBuilder()

New builder.

Returns:

a GetCuiInfoOptions builder

corpus

public String corpus()

Gets the corpus. Corpus name.

Returns:

the corpus

nameOrId

public String nameOrId()

Gets the nameOrId. Preferred name or concept ID.

Returns:

the nameOrId

ontology

public String ontology()

Gets the ontology. The ontology that defines the cui.

Returns:

the ontology

fields

public String fields()

Gets the fields. Comma separated list of fields to return: preferredName, semanticTypes, surfaceForms, typeahead, variants, definition. Defaults to all fields.

Returns:

the fields

treeLayout

public Boolean treeLayout()

Gets the treeLayout. Generate JSON output that is compatible with a d3 tree layout. Default is false.

Returns:

the treeLayout