FederatedQueryNoticesOptions.Builder (IBM Watson Java SDK 9.2.0 API)

java.lang.Object
- com.ibm.watson.discovery.v1.model.FederatedQueryNoticesOptions.Builder

Enclosing class:: FederatedQueryNoticesOptions

public static class FederatedQueryNoticesOptions.Builder
extends Object

Builder.

Constructor Summary

Constructors
Constructor and Description
`Builder()` Instantiates a new builder.
`Builder(String environmentId, List<String> collectionIds)` Instantiates a new builder with required properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FederatedQueryNoticesOptions.Builder`	`addCollectionIds(String collectionIds)` Adds an collectionIds to collectionIds.
`FederatedQueryNoticesOptions.Builder`	`addReturnField(String returnField)` Adds an returnField to xReturn.
`FederatedQueryNoticesOptions.Builder`	`addSimilarDocumentIds(String similarDocumentIds)` Adds an similarDocumentIds to similarDocumentIds.
`FederatedQueryNoticesOptions.Builder`	`addSimilarFields(String similarFields)` Adds an similarFields to similarFields.
`FederatedQueryNoticesOptions.Builder`	`addSort(String sort)` Adds an sort to sort.
`FederatedQueryNoticesOptions.Builder`	`aggregation(String aggregation)` Set the aggregation.
`FederatedQueryNoticesOptions`	`build()` Builds a FederatedQueryNoticesOptions.
`FederatedQueryNoticesOptions.Builder`	`collectionIds(List<String> collectionIds)` Set the collectionIds.
`FederatedQueryNoticesOptions.Builder`	`count(long count)` Set the count.
`FederatedQueryNoticesOptions.Builder`	`deduplicateField(String deduplicateField)` Set the deduplicateField.
`FederatedQueryNoticesOptions.Builder`	`environmentId(String environmentId)` Set the environmentId.
`FederatedQueryNoticesOptions.Builder`	`filter(String filter)` Set the filter.
`FederatedQueryNoticesOptions.Builder`	`highlight(Boolean highlight)` Set the highlight.
`FederatedQueryNoticesOptions.Builder`	`naturalLanguageQuery(String naturalLanguageQuery)` Set the naturalLanguageQuery.
`FederatedQueryNoticesOptions.Builder`	`offset(long offset)` Set the offset.
`FederatedQueryNoticesOptions.Builder`	`query(String query)` Set the query.
`FederatedQueryNoticesOptions.Builder`	`similar(Boolean similar)` Set the similar.
`FederatedQueryNoticesOptions.Builder`	`similarDocumentIds(List<String> similarDocumentIds)` Set the similarDocumentIds.
`FederatedQueryNoticesOptions.Builder`	`similarFields(List<String> similarFields)` Set the similarFields.
`FederatedQueryNoticesOptions.Builder`	`sort(List<String> sort)` Set the sort.
`FederatedQueryNoticesOptions.Builder`	`xReturn(List<String> xReturn)` Set the xReturn.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
    Instantiates a new builder.
  - Builder
```
public Builder(String environmentId,
               List<String> collectionIds)
```
    Instantiates a new builder with required properties.
    
    Parameters:
    
    environmentId - the environmentId
    
    collectionIds - the collectionIds
- Method Detail
  - build
```
public FederatedQueryNoticesOptions build()
```
    Builds a FederatedQueryNoticesOptions.
    
    Returns:
    
    the new FederatedQueryNoticesOptions instance
  - addCollectionIds
```
public FederatedQueryNoticesOptions.Builder addCollectionIds(String collectionIds)
```
    Adds an collectionIds to collectionIds.
    
    Parameters:
    
    collectionIds - the new collectionIds
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - addReturnField
```
public FederatedQueryNoticesOptions.Builder addReturnField(String returnField)
```
    Adds an returnField to xReturn.
    
    Parameters:
    
    returnField - the new returnField
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - addSort
```
public FederatedQueryNoticesOptions.Builder addSort(String sort)
```
    Adds an sort to sort.
    
    Parameters:
    
    sort - the new sort
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - addSimilarDocumentIds
```
public FederatedQueryNoticesOptions.Builder addSimilarDocumentIds(String similarDocumentIds)
```
    Adds an similarDocumentIds to similarDocumentIds.
    
    Parameters:
    
    similarDocumentIds - the new similarDocumentIds
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - addSimilarFields
```
public FederatedQueryNoticesOptions.Builder addSimilarFields(String similarFields)
```
    Adds an similarFields to similarFields.
    
    Parameters:
    
    similarFields - the new similarFields
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - environmentId
```
public FederatedQueryNoticesOptions.Builder environmentId(String environmentId)
```
    Set the environmentId.
    
    Parameters:
    
    environmentId - the environmentId
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - collectionIds
```
public FederatedQueryNoticesOptions.Builder collectionIds(List<String> collectionIds)
```
    Set the collectionIds. Existing collectionIds will be replaced.
    
    Parameters:
    
    collectionIds - the collectionIds
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - filter
```
public FederatedQueryNoticesOptions.Builder filter(String filter)
```
    Set the filter.
    
    Parameters:
    
    filter - the filter
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - query
```
public FederatedQueryNoticesOptions.Builder query(String query)
```
    Set the query.
    
    Parameters:
    
    query - the query
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - naturalLanguageQuery
```
public FederatedQueryNoticesOptions.Builder naturalLanguageQuery(String naturalLanguageQuery)
```
    Set the naturalLanguageQuery.
    
    Parameters:
    
    naturalLanguageQuery - the naturalLanguageQuery
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - aggregation
```
public FederatedQueryNoticesOptions.Builder aggregation(String aggregation)
```
    Set the aggregation.
    
    Parameters:
    
    aggregation - the aggregation
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - count
```
public FederatedQueryNoticesOptions.Builder count(long count)
```
    Set the count.
    
    Parameters:
    
    count - the count
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - xReturn
```
public FederatedQueryNoticesOptions.Builder xReturn(List<String> xReturn)
```
    Set the xReturn. Existing xReturn will be replaced.
    
    Parameters:
    
    xReturn - the xReturn
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - offset
```
public FederatedQueryNoticesOptions.Builder offset(long offset)
```
    Set the offset.
    
    Parameters:
    
    offset - the offset
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - sort
```
public FederatedQueryNoticesOptions.Builder sort(List<String> sort)
```
    Set the sort. Existing sort will be replaced.
    
    Parameters:
    
    sort - the sort
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - highlight
```
public FederatedQueryNoticesOptions.Builder highlight(Boolean highlight)
```
    Set the highlight.
    
    Parameters:
    
    highlight - the highlight
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - deduplicateField
```
public FederatedQueryNoticesOptions.Builder deduplicateField(String deduplicateField)
```
    Set the deduplicateField.
    
    Parameters:
    
    deduplicateField - the deduplicateField
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - similar
```
public FederatedQueryNoticesOptions.Builder similar(Boolean similar)
```
    Set the similar.
    
    Parameters:
    
    similar - the similar
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - similarDocumentIds
```
public FederatedQueryNoticesOptions.Builder similarDocumentIds(List<String> similarDocumentIds)
```
    Set the similarDocumentIds. Existing similarDocumentIds will be replaced.
    
    Parameters:
    
    similarDocumentIds - the similarDocumentIds
    
    Returns:
    
    the FederatedQueryNoticesOptions builder
  - similarFields
```
public FederatedQueryNoticesOptions.Builder similarFields(List<String> similarFields)
```
    Set the similarFields. Existing similarFields will be replaced.
    
    Parameters:
    
    similarFields - the similarFields
    
    Returns:
    
    the FederatedQueryNoticesOptions builder

Class FederatedQueryNoticesOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

build

addCollectionIds

addReturnField

addSort

addSimilarDocumentIds

addSimilarFields

environmentId

collectionIds

filter

query

naturalLanguageQuery

aggregation

count

xReturn

offset

sort

highlight

deduplicateField

similar

similarDocumentIds

similarFields