com.ibm.watson.discovery.v2.model

Class QueryCollectionNoticesOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.QueryCollectionNoticesOptions

All Implemented Interfaces:

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

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

The queryCollectionNotices options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	collectionId() Gets the collectionId.
Long	count() Gets the count.
String	filter() Gets the filter.
String	naturalLanguageQuery() Gets the naturalLanguageQuery.
QueryCollectionNoticesOptions.Builder	newBuilder() New builder.
Long	offset() Gets the offset.
String	projectId() Gets the projectId.
String	query() Gets the query.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public QueryCollectionNoticesOptions.Builder newBuilder()

New builder.

Returns:

a QueryCollectionNoticesOptions builder

projectId

public String projectId()

Gets the projectId.

The ID of the project. This information can be found from the *Integrate and Deploy* page in Discovery.

Returns:

the projectId

collectionId

public String collectionId()

Gets the collectionId.

The ID of the collection.

Returns:

the collectionId

filter

public String filter()

Gets the filter.

Searches for documents that match the Discovery Query Language criteria that is specified as input. Filter calls are cached and are faster than query calls because the results are not ordered by relevance. When used with the `aggregation`, `query`, or `natural_language_query` parameters, the `filter` parameter runs first. This parameter is useful for limiting results to those that contain specific metadata values.

Returns:

the filter

query

public String query()

Gets the query.

A query search that is written in the Discovery Query Language and returns all matching documents in your data set with full enrichments and full text, and with the most relevant documents listed first. You can use this parameter or the **natural_language_query** parameter to specify the query input, but not both.

Returns:

the query

naturalLanguageQuery

public String naturalLanguageQuery()

Gets the naturalLanguageQuery.

A natural language query that returns relevant documents by using natural language understanding. You can use this parameter or the **query** parameter to specify the query input, but not both. To filter the results based on criteria you specify, include the **filter** parameter in the request.

Returns:

the naturalLanguageQuery

count

public Long count()

Gets the count.

Number of results to return. The maximum for the **count** and **offset** values together in any one query is **10,000**.

Returns:

the count

offset

public Long offset()

Gets the offset.

The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the **count** and **offset** values together in any one query is **10000**.

Returns:

the offset