com.ibm.watson.developer_cloud.discovery.v1.model

Class QueryOptions.Builder

java.lang.Object

com.ibm.watson.developer_cloud.discovery.v1.model.QueryOptions.Builder

Enclosing class:

QueryOptions

public static class QueryOptions.Builder
extends java.lang.Object

Builder.

Constructor Summary

Constructors

Constructor and Description
QueryOptions.Builder() Instantiates a new builder.
QueryOptions.Builder(java.lang.String environmentId, java.lang.String collectionId) Instantiates a new builder with required properties.

Method Summary

Methods

Modifier and Type	Method and Description
QueryOptions.Builder	addCollectionIds(java.lang.String collectionIds) Deprecated. collectionIds is now of type String, so this method will be removed in the next major release
QueryOptions.Builder	addPassagesFields(java.lang.String passagesFields) Deprecated. passagesFields is now of type String, so this method will be removed in the next major release
QueryOptions.Builder	addReturnField(java.lang.String returnField) Deprecated. returnFields is now of type String, so this method will be removed in the next major release
QueryOptions.Builder	addSimilarDocumentIds(java.lang.String similarDocumentIds) Deprecated. similarDocumentIds is now of type String, so this method will be removed in the next major release
QueryOptions.Builder	addSimilarFields(java.lang.String similarFields) Deprecated. similarFields is now of type String, so this method will be removed in the next major release
QueryOptions.Builder	addSort(java.lang.String sort) Deprecated. sort is now of type String, so this method will be removed in the next major release
QueryOptions.Builder	aggregation(java.lang.String aggregation) Set the aggregation.
QueryOptions.Builder	bias(java.lang.String bias) Set the bias.
QueryOptions	build() Builds a QueryOptions.
QueryOptions.Builder	collectionId(java.lang.String collectionId) Set the collectionId.
QueryOptions.Builder	collectionIds(java.util.List<java.lang.String> collectionIds) Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.
QueryOptions.Builder	collectionIds(java.lang.String collectionIds) Set the collectionIds.
QueryOptions.Builder	count(long count) Set the count.
QueryOptions.Builder	deduplicate(java.lang.Boolean deduplicate) Set the deduplicate.
QueryOptions.Builder	deduplicateField(java.lang.String deduplicateField) Set the deduplicateField.
QueryOptions.Builder	environmentId(java.lang.String environmentId) Set the environmentId.
QueryOptions.Builder	filter(java.lang.String filter) Set the filter.
QueryOptions.Builder	highlight(java.lang.Boolean highlight) Set the highlight.
QueryOptions.Builder	loggingOptOut(java.lang.Boolean loggingOptOut) Set the loggingOptOut.
QueryOptions.Builder	naturalLanguageQuery(java.lang.String naturalLanguageQuery) Set the naturalLanguageQuery.
QueryOptions.Builder	offset(long offset) Set the offset.
QueryOptions.Builder	passages(java.lang.Boolean passages) Set the passages.
QueryOptions.Builder	passagesCharacters(long passagesCharacters) Set the passagesCharacters.
QueryOptions.Builder	passagesCount(long passagesCount) Set the passagesCount.
QueryOptions.Builder	passagesFields(java.util.List<java.lang.String> passagesFields) Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.
QueryOptions.Builder	passagesFields(java.lang.String passagesFields) Set the passagesFields.
QueryOptions.Builder	query(java.lang.String query) Set the query.
QueryOptions.Builder	returnFields(java.util.List<java.lang.String> returnFields) Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.
QueryOptions.Builder	returnFields(java.lang.String returnFields) Set the returnFields.
QueryOptions.Builder	similar(java.lang.Boolean similar) Set the similar.
QueryOptions.Builder	similarDocumentIds(java.util.List<java.lang.String> similarDocumentIds) Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.
QueryOptions.Builder	similarDocumentIds(java.lang.String similarDocumentIds) Set the similarDocumentIds.
QueryOptions.Builder	similarFields(java.util.List<java.lang.String> similarFields) Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.
QueryOptions.Builder	similarFields(java.lang.String similarFields) Set the similarFields.
QueryOptions.Builder	sort(java.util.List<java.lang.String> sort) Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.
QueryOptions.Builder	sort(java.lang.String sort) Set the sort.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryOptions.Builder

public QueryOptions.Builder()

Instantiates a new builder.

QueryOptions.Builder

public QueryOptions.Builder(java.lang.String environmentId,
                    java.lang.String collectionId)

Instantiates a new builder with required properties.

Parameters:

environmentId - the environmentId

collectionId - the collectionId

Method Detail

build

public QueryOptions build()

Builds a QueryOptions.

Returns:

the queryOptions

addReturnField

public QueryOptions.Builder addReturnField(java.lang.String returnField)

Deprecated. returnFields is now of type String, so this method will be removed in the next major release

Adds an returnField to returnFields.

Parameters:

returnField - the new returnField

Returns:

the QueryOptions builder

addSort

public QueryOptions.Builder addSort(java.lang.String sort)

Deprecated. sort is now of type String, so this method will be removed in the next major release

Adds an sort to sort.

Parameters:

sort - the new sort

Returns:

the QueryOptions builder

addPassagesFields

public QueryOptions.Builder addPassagesFields(java.lang.String passagesFields)

Deprecated. passagesFields is now of type String, so this method will be removed in the next major release

Adds an passagesFields to passagesFields.

Parameters:

passagesFields - the new passagesFields

Returns:

the QueryOptions builder

addCollectionIds

public QueryOptions.Builder addCollectionIds(java.lang.String collectionIds)

Deprecated. collectionIds is now of type String, so this method will be removed in the next major release

Adds an collectionIds to collectionIds.

Parameters:

collectionIds - the new collectionIds

Returns:

the QueryOptions builder

addSimilarDocumentIds

public QueryOptions.Builder addSimilarDocumentIds(java.lang.String similarDocumentIds)

Deprecated. similarDocumentIds is now of type String, so this method will be removed in the next major release

Adds an similarDocumentIds to similarDocumentIds.

Parameters:

similarDocumentIds - the new similarDocumentIds

Returns:

the QueryOptions builder

addSimilarFields

public QueryOptions.Builder addSimilarFields(java.lang.String similarFields)

Deprecated. similarFields is now of type String, so this method will be removed in the next major release

Adds an similarFields to similarFields.

Parameters:

similarFields - the new similarFields

Returns:

the QueryOptions builder

environmentId

public QueryOptions.Builder environmentId(java.lang.String environmentId)

Set the environmentId.

Parameters:

environmentId - the environmentId

Returns:

the QueryOptions builder

collectionId

public QueryOptions.Builder collectionId(java.lang.String collectionId)

Set the collectionId.

Parameters:

collectionId - the collectionId

Returns:

the QueryOptions builder

filter

public QueryOptions.Builder filter(java.lang.String filter)

Set the filter.

Parameters:

filter - the filter

Returns:

the QueryOptions builder

query

public QueryOptions.Builder query(java.lang.String query)

Set the query.

Parameters:

query - the query

Returns:

the QueryOptions builder

naturalLanguageQuery

public QueryOptions.Builder naturalLanguageQuery(java.lang.String naturalLanguageQuery)

Set the naturalLanguageQuery.

Parameters:

naturalLanguageQuery - the naturalLanguageQuery

Returns:

the QueryOptions builder

passages

public QueryOptions.Builder passages(java.lang.Boolean passages)

Set the passages.

Parameters:

passages - the passages

Returns:

the QueryOptions builder

aggregation

public QueryOptions.Builder aggregation(java.lang.String aggregation)

Set the aggregation.

Parameters:

aggregation - the aggregation

Returns:

the QueryOptions builder

count

public QueryOptions.Builder count(long count)

Set the count.

Parameters:

count - the count

Returns:

the QueryOptions builder

returnFields

public QueryOptions.Builder returnFields(java.lang.String returnFields)

Set the returnFields.

Parameters:

returnFields - the returnFields

Returns:

the QueryOptions builder

returnFields

public QueryOptions.Builder returnFields(java.util.List<java.lang.String> returnFields)

Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.

Set the returnFields.

Parameters:

returnFields - the returnFields

Returns:

the QueryOptions builder

offset

public QueryOptions.Builder offset(long offset)

Set the offset.

Parameters:

offset - the offset

Returns:

the QueryOptions builder

sort

public QueryOptions.Builder sort(java.lang.String sort)

Set the sort.

Parameters:

sort - the sort

Returns:

the QueryOptions builder

sort

public QueryOptions.Builder sort(java.util.List<java.lang.String> sort)

Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.

Set the sort.

Parameters:

sort - the sort

Returns:

the QueryOptions builder

highlight

public QueryOptions.Builder highlight(java.lang.Boolean highlight)

Set the highlight.

Parameters:

highlight - the highlight

Returns:

the QueryOptions builder

passagesFields

public QueryOptions.Builder passagesFields(java.lang.String passagesFields)

Set the passagesFields.

Parameters:

passagesFields - the passagesFields

Returns:

the QueryOptions builder

passagesFields

public QueryOptions.Builder passagesFields(java.util.List<java.lang.String> passagesFields)

Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.

Set the passagesFields.

Parameters:

passagesFields - the passagesFields

Returns:

the QueryOptions builder

passagesCount

public QueryOptions.Builder passagesCount(long passagesCount)

Set the passagesCount.

Parameters:

passagesCount - the passagesCount

Returns:

the QueryOptions builder

passagesCharacters

public QueryOptions.Builder passagesCharacters(long passagesCharacters)

Set the passagesCharacters.

Parameters:

passagesCharacters - the passagesCharacters

Returns:

the QueryOptions builder

deduplicate

public QueryOptions.Builder deduplicate(java.lang.Boolean deduplicate)

Set the deduplicate.

Parameters:

deduplicate - the deduplicate

Returns:

the QueryOptions builder

deduplicateField

public QueryOptions.Builder deduplicateField(java.lang.String deduplicateField)

Set the deduplicateField.

Parameters:

deduplicateField - the deduplicateField

Returns:

the QueryOptions builder

collectionIds

public QueryOptions.Builder collectionIds(java.lang.String collectionIds)

Set the collectionIds.

Parameters:

collectionIds - the collectionIds

Returns:

the QueryOptions builder

collectionIds

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

Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.

Set the collectionIds.

Parameters:

collectionIds - the collectionIds

Returns:

the QueryOptions builder

similar

public QueryOptions.Builder similar(java.lang.Boolean similar)

Set the similar.

Parameters:

similar - the similar

Returns:

the QueryOptions builder

similarDocumentIds

public QueryOptions.Builder similarDocumentIds(java.lang.String similarDocumentIds)

Set the similarDocumentIds.

Parameters:

similarDocumentIds - the similarDocumentIds

Returns:

the QueryOptions builder

similarDocumentIds

public QueryOptions.Builder similarDocumentIds(java.util.List<java.lang.String> similarDocumentIds)

Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.

Set the similarDocumentIds.

Parameters:

similarDocumentIds - the similarDocumentIds

Returns:

the QueryOptions builder

similarFields

public QueryOptions.Builder similarFields(java.lang.String similarFields)

Set the similarFields.

Parameters:

similarFields - the similarFields

Returns:

the QueryOptions builder

similarFields

public QueryOptions.Builder similarFields(java.util.List<java.lang.String> similarFields)

Deprecated. This parameter is now officially of type String. Please set this as a comma-separated String with the other setter.

Set the similarFields.

Parameters:

similarFields - the similarFields

Returns:

the QueryOptions builder

bias

public QueryOptions.Builder bias(java.lang.String bias)

Set the bias.

Parameters:

bias - the bias

Returns:

the QueryOptions builder

loggingOptOut

public QueryOptions.Builder loggingOptOut(java.lang.Boolean loggingOptOut)

Set the loggingOptOut.

Parameters:

loggingOptOut - the loggingOptOut

Returns:

the QueryOptions builder