com.ibm.watson.discovery.v1.model

Class GetAutocompletionOptions

java.lang.Object

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

com.ibm.watson.discovery.v1.model.GetAutocompletionOptions

All Implemented Interfaces:

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

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

The getAutocompletion options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	collectionId() Gets the collectionId.
Long	count() Gets the count.
String	environmentId() Gets the environmentId.
String	field() Gets the field.
GetAutocompletionOptions.Builder	newBuilder() New builder.
String	prefix() Gets the prefix.

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 GetAutocompletionOptions.Builder newBuilder()

New builder.

Returns:

a GetAutocompletionOptions builder

environmentId

public String environmentId()

Gets the environmentId.

The ID of the environment.

Returns:

the environmentId

collectionId

public String collectionId()

Gets the collectionId.

The ID of the collection.

Returns:

the collectionId

prefix

public String prefix()

Gets the prefix.

The prefix to use for autocompletion. For example, the prefix `Ho` could autocomplete to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are.

Returns:

the prefix

field

public String field()

Gets the field.

The field in the result documents that autocompletion suggestions are identified from.

Returns:

the field

count

public Long count()

Gets the count.

The number of autocompletion suggestions to return.

Returns:

the count