com.ibm.watson.discovery.v1.model

Class FederatedQueryOptions.Builder

java.lang.Object

com.ibm.watson.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, java.lang.String collectionIds) Instantiates a new builder with required properties.

Method Summary

Methods

Modifier and Type	Method and Description
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.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	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.lang.String passagesFields) Set the passagesFields.
FederatedQueryOptions.Builder	query(java.lang.String query) Set the query.
FederatedQueryOptions.Builder	similar(java.lang.Boolean similar) Set the similar.
FederatedQueryOptions.Builder	similarDocumentIds(java.lang.String similarDocumentIds) Set the similarDocumentIds.
FederatedQueryOptions.Builder	similarFields(java.lang.String similarFields) Set the similarFields.
FederatedQueryOptions.Builder	sort(java.lang.String sort) Set the sort.
FederatedQueryOptions.Builder	xReturn(java.lang.String xReturn) Set the xReturn.
FederatedQueryOptions.Builder	xWatsonLoggingOptOut(java.lang.Boolean xWatsonLoggingOptOut) Set the xWatsonLoggingOptOut.

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,
                             java.lang.String collectionIds)

Instantiates a new builder with required properties.

Parameters:

environmentId - the environmentId

collectionIds - the collectionIds

Method Detail

build

public FederatedQueryOptions build()

Builds a FederatedQueryOptions.

Returns:

the federatedQueryOptions

environmentId

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

Set the environmentId.

Parameters:

environmentId - the environmentId

Returns:

the FederatedQueryOptions builder

collectionIds

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

Set the collectionIds.

Parameters:

collectionIds - the collectionIds

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

xReturn

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

Set the xReturn.

Parameters:

xReturn - the xReturn

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

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

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

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

similarFields

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

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

xWatsonLoggingOptOut

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

Set the xWatsonLoggingOptOut.

Parameters:

xWatsonLoggingOptOut - the xWatsonLoggingOptOut

Returns:

the FederatedQueryOptions builder