com.ibm.watson.discovery.v2.model

Class DefaultQueryParams

java.lang.Object

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

com.ibm.watson.discovery.v2.model.DefaultQueryParams

All Implemented Interfaces:

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

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

Default query parameters for this project.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	aggregation
protected java.util.List<java.lang.String>	collectionIds
protected java.lang.Long	count
protected java.lang.Boolean	highlight
protected DefaultQueryParamsPassages	passages
protected java.lang.String	sort
protected java.lang.Boolean	spellingSuggestions
protected DefaultQueryParamsSuggestedRefinements	suggestedRefinements
protected DefaultQueryParamsTableResults	tableResults
protected java.util.List<java.lang.String>	xReturn

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	aggregation() Gets the aggregation.
java.util.List<java.lang.String>	collectionIds() Gets the collectionIds.
java.lang.Long	count() Gets the count.
java.lang.Boolean	highlight() Gets the highlight.
DefaultQueryParams.Builder	newBuilder() New builder.
DefaultQueryParamsPassages	passages() Gets the passages.
java.lang.String	sort() Gets the sort.
java.lang.Boolean	spellingSuggestions() Gets the spellingSuggestions.
DefaultQueryParamsSuggestedRefinements	suggestedRefinements() Gets the suggestedRefinements.
DefaultQueryParamsTableResults	tableResults() Gets the tableResults.
java.util.List<java.lang.String>	xReturn() Gets the xReturn.

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

collectionIds

@SerializedName(value="collection_ids")
protected java.util.List<java.lang.String> collectionIds

passages

protected DefaultQueryParamsPassages passages

tableResults

@SerializedName(value="table_results")
protected DefaultQueryParamsTableResults tableResults

aggregation

protected java.lang.String aggregation

suggestedRefinements

@SerializedName(value="suggested_refinements")
protected DefaultQueryParamsSuggestedRefinements suggestedRefinements

spellingSuggestions

@SerializedName(value="spelling_suggestions")
protected java.lang.Boolean spellingSuggestions

highlight

protected java.lang.Boolean highlight

count

protected java.lang.Long count

sort

protected java.lang.String sort

xReturn

@SerializedName(value="return")
protected java.util.List<java.lang.String> xReturn

Constructor Detail

DefaultQueryParams

protected DefaultQueryParams(DefaultQueryParams.Builder builder)

Method Detail

newBuilder

public DefaultQueryParams.Builder newBuilder()

New builder.

Returns:

a DefaultQueryParams builder

collectionIds

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

Gets the collectionIds.

An array of collection identifiers to query. If empty or omitted all collections in the project are queried.

Returns:

the collectionIds

passages

public DefaultQueryParamsPassages passages()

Gets the passages.

Default settings configuration for passage search options.

Returns:

the passages

tableResults

public DefaultQueryParamsTableResults tableResults()

Gets the tableResults.

Default project query settings for table results.

Returns:

the tableResults

aggregation

public java.lang.String aggregation()

Gets the aggregation.

A string representing the default aggregation query for the project.

Returns:

the aggregation

suggestedRefinements

public DefaultQueryParamsSuggestedRefinements suggestedRefinements()

Gets the suggestedRefinements.

Object containing suggested refinement settings.

Returns:

the suggestedRefinements

spellingSuggestions

public java.lang.Boolean spellingSuggestions()

Gets the spellingSuggestions.

When `true`, a spelling suggestions for the query are retuned by default.

Returns:

the spellingSuggestions

highlight

public java.lang.Boolean highlight()

Gets the highlight.

When `true`, a highlights for the query are retuned by default.

Returns:

the highlight

count

public java.lang.Long count()

Gets the count.

The number of document results returned by default.

Returns:

the count

sort

public java.lang.String sort()

Gets the sort.

A comma separated list of document fields to sort results by default.

Returns:

the sort

xReturn

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

Gets the xReturn.

An array of field names to return in document results if present by default.

Returns:

the xReturn