com.ibm.watson.discovery.v2.model

Class GetAutocompletionOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.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
List<String>	collectionIds() Gets the collectionIds.
Long	count() Gets the count.
String	field() Gets the field.
GetAutocompletionOptions.Builder	newBuilder() New builder.
String	prefix() Gets the prefix.
String	projectId() Gets the projectId.

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

projectId

public String projectId()

Gets the projectId.

The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Returns:

the projectId

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

collectionIds

public List<String> collectionIds()

Gets the collectionIds.

Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are used.

Returns:

the collectionIds

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