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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionId
protected java.lang.Long	count
protected java.lang.String	environmentId
protected java.lang.String	field
protected java.lang.String	prefix

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	collectionId() Gets the collectionId.
java.lang.Long	count() Gets the count.
java.lang.String	environmentId() Gets the environmentId.
java.lang.String	field() Gets the field.
GetAutocompletionOptions.Builder	newBuilder() New builder.
java.lang.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

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

Field Detail

environmentId

protected java.lang.String environmentId

collectionId

protected java.lang.String collectionId

prefix

protected java.lang.String prefix

field

protected java.lang.String field

count

protected java.lang.Long count

Constructor Detail

GetAutocompletionOptions

protected GetAutocompletionOptions(GetAutocompletionOptions.Builder builder)

Method Detail

newBuilder

public GetAutocompletionOptions.Builder newBuilder()

New builder.

Returns:

a GetAutocompletionOptions builder

environmentId

public java.lang.String environmentId()

Gets the environmentId.

The ID of the environment.

Returns:

the environmentId

collectionId

public java.lang.String collectionId()

Gets the collectionId.

The ID of the collection.

Returns:

the collectionId

prefix

public java.lang.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 java.lang.String field()

Gets the field.

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

Returns:

the field

count

public java.lang.Long count()

Gets the count.

The number of autocompletion suggestions to return.

Returns:

the count