Package com.ibm.cloud.cloudant.v1.model

Class PostSearchOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.cloudant.v1.model.PostSearchOptions
All Implemented Interfaces:
ObjectModel
public class PostSearchOptions extends GenericModel
The postSearch options.

  • Method Details

    • newBuilder

      public PostSearchOptions.Builder newBuilder()
      New builder.
      Returns:
      a PostSearchOptions builder

    • db

      public String db()
      Gets the db. Path parameter to specify the database name.
      Returns:
      the db

    • ddoc

      public String ddoc()
      Gets the ddoc. Path parameter to specify the design document name. The design document name is the design document ID excluding the `_design/` prefix.
      Returns:
      the ddoc

    • index

      public String index()
      Gets the index. Path parameter to specify the index name.
      Returns:
      the index

    • query

      public String query()
      Gets the query. The Lucene query to execute.
      Returns:
      the query

    • bookmark

      public String bookmark()
      Gets the bookmark. Opaque bookmark token used when paginating results.
      Returns:
      the bookmark

    • highlightFields

      public List<String> highlightFields()
      Gets the highlightFields. Specifies which fields to highlight. If specified, the result object contains a highlights field with an entry for each specified field.
      Returns:
      the highlightFields

    • highlightNumber

      public Long highlightNumber()
      Gets the highlightNumber. Number of fragments that are returned in highlights. If the search term occurs less often than the number of fragments that are specified, longer fragments are returned.
      Returns:
      the highlightNumber

    • highlightPostTag

      public String highlightPostTag()
      Gets the highlightPostTag. A string that is inserted after the highlighted word in the highlights output.
      Returns:
      the highlightPostTag

    • highlightPreTag

      public String highlightPreTag()
      Gets the highlightPreTag. A string that is inserted before the highlighted word in the highlights output.
      Returns:
      the highlightPreTag

    • highlightSize

      public Long highlightSize()
      Gets the highlightSize. Number of characters in each fragment for highlights.
      Returns:
      the highlightSize

    • includeDocs

      public Boolean includeDocs()
      Gets the includeDocs. Include the full content of the documents in the return.
      Returns:
      the includeDocs

    • includeFields

      public List<String> includeFields()
      Gets the includeFields. A JSON array of field names to include in search results. Any fields that are included must be indexed with the store:true option. The default is all fields.
      Returns:
      the includeFields

    • limit

      public Long limit()
      Gets the limit. Limit the number of the returned documents to the specified number.
      Returns:
      the limit

    • sort

      public List<String> sort()
      Gets the sort. Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter specifies the sort order within a group. The default sort order is relevance. A JSON string of the form "fieldname&lt;type&gt;" or "-fieldname&lt;type&gt;" for descending order, where fieldname is the name of a string or number field, and type is either a number, a string, or a JSON array of strings. The type part is optional, and defaults to number. Some examples are "foo", "-foo", "bar&lt;string&gt;", "-foo&lt;number&gt;" and ["-foo&lt;number&gt;", "bar&lt;string&gt;"]. String fields that are used for sorting must not be analyzed fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.
      Returns:
      the sort

    • stale

      public String stale()
      Gets the stale. Do not wait for the index to finish building to return results.
      Returns:
      the stale

    • counts

      public List<String> counts()
      Gets the counts. This field defines an array of names of string fields, for which counts are requested. The response contains counts for each unique value of this field name among the documents that match the search query. Faceting must be enabled for this parameter to function. This option is only available when making global queries.
      Returns:
      the counts

    • drilldown

      public List<List<String>> drilldown()
      Gets the drilldown. Restrict results to documents with a dimension equal to the specified label(s). The search matches only documents containing the value that was provided in the named field. It differs from using "fieldname:value" in the q parameter only in that the values are not analyzed. Faceting must be enabled for this parameter to function.
      Returns:
      the drilldown

    • groupField

      public String groupField()
      Gets the groupField. Field by which to group search matches. A string that contains the name of a string field. Fields containing other data such as numbers, objects, or arrays cannot be used. This option is only available when making global queries.
      Returns:
      the groupField

    • groupLimit

      public Long groupLimit()
      Gets the groupLimit. Maximum group count. This field can be used only if group_field is specified. This option is only available when making global queries.
      Returns:
      the groupLimit

    • groupSort

      public List<String> groupSort()
      Gets the groupSort. This field defines the order of the groups in a search that uses group_field. The default sort order is relevance. This field can have the same values as the sort field, so single fields and arrays of fields are supported. This option is only available when making global queries.
      Returns:
      the groupSort

    • ranges

      public Map<String,Map<String,Map<String,String>>> ranges()
      Gets the ranges. This field defines ranges for faceted, numeric search fields. The value is a JSON object where the fields names are faceted numeric search fields, and the values of the fields are JSON objects. The field names of the JSON objects are names for ranges. The values are strings that describe the range, for example "[0 TO 10]". This option is only available when making global queries.
      Returns:
      the ranges