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

Class FederatedQueryOptions.Builder

java.lang.Object

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

Enclosing class:

FederatedQueryOptions

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

Builder.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
FederatedQueryOptions.Builder	addCollectionIds(java.lang.String collectionIds) Deprecated. collectionIds is now of type String, so this method will be removed in the next major release
FederatedQueryOptions.Builder	addPassagesFields(java.lang.String passagesFields) Deprecated. passagesFields is now of type String, so this method will be removed in the next major release
FederatedQueryOptions.Builder	addReturnField(java.lang.String returnField) Deprecated. returnFields is now of type String, so this method will be removed in the next major release
FederatedQueryOptions.Builder	addSimilarDocumentIds(java.lang.String similarDocumentIds) Deprecated. similarDocumentIds is now of type String, so this method will be removed in the next major release
FederatedQueryOptions.Builder	addSimilarFields(java.lang.String similarFields) Deprecated. similarFields is now of type String, so this method will be removed in the next major release
FederatedQueryOptions.Builder	addSort(java.lang.String sort) Deprecated. sort is now of type String, so this method will be removed in the next major release
FederatedQueryOptions.Builder	aggregation(java.lang.String aggregation) Set the aggregation.
FederatedQueryOptions.Builder	bias(java.lang.String bias) Set the bias.
FederatedQueryOptions	build() Builds a FederatedQueryOptions.
FederatedQueryOptions.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.
FederatedQueryOptions.Builder	collectionIds(java.lang.String collectionIds) Set the collectionIds.
FederatedQueryOptions.Builder	count(long count) Set the count.
FederatedQueryOptions.Builder	deduplicate(java.lang.Boolean deduplicate) Set the deduplicate.
FederatedQueryOptions.Builder	deduplicateField(java.lang.String deduplicateField) Set the deduplicateField.
FederatedQueryOptions.Builder	environmentId(java.lang.String environmentId) Set the environmentId.
FederatedQueryOptions.Builder	filter(java.lang.String filter) Set the filter.
FederatedQueryOptions.Builder	highlight(java.lang.Boolean highlight) Set the highlight.
FederatedQueryOptions.Builder	loggingOptOut(java.lang.Boolean loggingOptOut) Set the loggingOptOut.
FederatedQueryOptions.Builder	naturalLanguageQuery(java.lang.String naturalLanguageQuery) Set the naturalLanguageQuery.
FederatedQueryOptions.Builder	offset(long offset) Set the offset.
FederatedQueryOptions.Builder	passages(java.lang.Boolean passages) Set the passages.
FederatedQueryOptions.Builder	passagesCharacters(long passagesCharacters) Set the passagesCharacters.
FederatedQueryOptions.Builder	passagesCount(long passagesCount) Set the passagesCount.
FederatedQueryOptions.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.
FederatedQueryOptions.Builder	passagesFields(java.lang.String passagesFields) Set the passagesFields.
FederatedQueryOptions.Builder	query(java.lang.String query) Set the query.
FederatedQueryOptions.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.
FederatedQueryOptions.Builder	returnFields(java.lang.String returnFields) Set the returnFields.
FederatedQueryOptions.Builder	similar(java.lang.Boolean similar) Set the similar.
FederatedQueryOptions.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.
FederatedQueryOptions.Builder	similarDocumentIds(java.lang.String similarDocumentIds) Set the similarDocumentIds.
FederatedQueryOptions.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.
FederatedQueryOptions.Builder	similarFields(java.lang.String similarFields) Set the similarFields.
FederatedQueryOptions.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.
FederatedQueryOptions.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

FederatedQueryOptions.Builder

public FederatedQueryOptions.Builder()

Instantiates a new builder.

FederatedQueryOptions.Builder

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

Instantiates a new builder with required properties.

Parameters:

environmentId - the environmentId

Method Detail

build

public FederatedQueryOptions build()

Builds a FederatedQueryOptions.

Returns:

the federatedQueryOptions

addReturnField

public FederatedQueryOptions.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 FederatedQueryOptions builder

addSort

public FederatedQueryOptions.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 FederatedQueryOptions builder

addPassagesFields

public FederatedQueryOptions.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 FederatedQueryOptions builder

addCollectionIds

public FederatedQueryOptions.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 FederatedQueryOptions builder

addSimilarDocumentIds

public FederatedQueryOptions.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 FederatedQueryOptions builder

addSimilarFields

public FederatedQueryOptions.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 FederatedQueryOptions builder

environmentId

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

Set the environmentId.

Parameters:

environmentId - the environmentId

Returns:

the FederatedQueryOptions builder

filter

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

Set the filter.

Parameters:

filter - the filter

Returns:

the FederatedQueryOptions builder

query

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

Set the query.

Parameters:

query - the query

Returns:

the FederatedQueryOptions builder

naturalLanguageQuery

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

Set the naturalLanguageQuery.

Parameters:

naturalLanguageQuery - the naturalLanguageQuery

Returns:

the FederatedQueryOptions builder

passages

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

Set the passages.

Parameters:

passages - the passages

Returns:

the FederatedQueryOptions builder

aggregation

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

Set the aggregation.

Parameters:

aggregation - the aggregation

Returns:

the FederatedQueryOptions builder

count

public FederatedQueryOptions.Builder count(long count)

Set the count.

Parameters:

count - the count

Returns:

the FederatedQueryOptions builder

returnFields

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

Set the returnFields.

Parameters:

returnFields - the returnFields

Returns:

the FederatedQueryOptions builder

returnFields

public FederatedQueryOptions.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 FederatedQueryOptions builder

offset

public FederatedQueryOptions.Builder offset(long offset)

Set the offset.

Parameters:

offset - the offset

Returns:

the FederatedQueryOptions builder

sort

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

Set the sort.

Parameters:

sort - the sort

Returns:

the FederatedQueryOptions builder

sort

public FederatedQueryOptions.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 FederatedQueryOptions builder

highlight

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

Set the highlight.

Parameters:

highlight - the highlight

Returns:

the FederatedQueryOptions builder

passagesFields

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

Set the passagesFields.

Parameters:

passagesFields - the passagesFields

Returns:

the FederatedQueryOptions builder

passagesFields

public FederatedQueryOptions.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 FederatedQueryOptions builder

passagesCount

public FederatedQueryOptions.Builder passagesCount(long passagesCount)

Set the passagesCount.

Parameters:

passagesCount - the passagesCount

Returns:

the FederatedQueryOptions builder

passagesCharacters

public FederatedQueryOptions.Builder passagesCharacters(long passagesCharacters)

Set the passagesCharacters.

Parameters:

passagesCharacters - the passagesCharacters

Returns:

the FederatedQueryOptions builder

deduplicate

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

Set the deduplicate.

Parameters:

deduplicate - the deduplicate

Returns:

the FederatedQueryOptions builder

deduplicateField

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

Set the deduplicateField.

Parameters:

deduplicateField - the deduplicateField

Returns:

the FederatedQueryOptions builder

collectionIds

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

Set the collectionIds.

Parameters:

collectionIds - the collectionIds

Returns:

the FederatedQueryOptions builder

collectionIds

public FederatedQueryOptions.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 FederatedQueryOptions builder

similar

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

Set the similar.

Parameters:

similar - the similar

Returns:

the FederatedQueryOptions builder

similarDocumentIds

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

Set the similarDocumentIds.

Parameters:

similarDocumentIds - the similarDocumentIds

Returns:

the FederatedQueryOptions builder

similarDocumentIds

public FederatedQueryOptions.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 FederatedQueryOptions builder

similarFields

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

Set the similarFields.

Parameters:

similarFields - the similarFields

Returns:

the FederatedQueryOptions builder

similarFields

public FederatedQueryOptions.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 FederatedQueryOptions builder

bias

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

Set the bias.

Parameters:

bias - the bias

Returns:

the FederatedQueryOptions builder

loggingOptOut

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

Set the loggingOptOut.

Parameters:

loggingOptOut - the loggingOptOut

Returns:

the FederatedQueryOptions builder