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

Class PostPartitionSearchOptions.Builder

java.lang.Object
com.ibm.cloud.cloudant.v1.model.PostPartitionSearchOptions.Builder
Enclosing class:
PostPartitionSearchOptions
public static class PostPartitionSearchOptions.Builder extends Object
Builder.

  • Constructor Details

    • Builder

      public Builder()
      Instantiates a new builder.

    • Builder

      public Builder(String db, String partitionKey, String ddoc, String index, String query)
      Instantiates a new builder with required properties.
      Parameters:
      db - the db
      partitionKey - the partitionKey
      ddoc - the ddoc
      index - the index
      query - the query

  • Method Details

    • build

      public PostPartitionSearchOptions build()
      Builds a PostPartitionSearchOptions.
      Returns:
      the new PostPartitionSearchOptions instance

    • addHighlightFields

      public PostPartitionSearchOptions.Builder addHighlightFields(String highlightFields)
      Adds a new element to highlightFields.
      Parameters:
      highlightFields - the new element to be added
      Returns:
      the PostPartitionSearchOptions builder

    • addIncludeFields

      public PostPartitionSearchOptions.Builder addIncludeFields(String includeFields)
      Adds a new element to includeFields.
      Parameters:
      includeFields - the new element to be added
      Returns:
      the PostPartitionSearchOptions builder

    • addSort

      public PostPartitionSearchOptions.Builder addSort(String sort)
      Adds a new element to sort.
      Parameters:
      sort - the new element to be added
      Returns:
      the PostPartitionSearchOptions builder

    • db

      public PostPartitionSearchOptions.Builder db(String db)
      Set the db.
      Parameters:
      db - the db
      Returns:
      the PostPartitionSearchOptions builder

    • partitionKey

      public PostPartitionSearchOptions.Builder partitionKey(String partitionKey)
      Set the partitionKey.
      Parameters:
      partitionKey - the partitionKey
      Returns:
      the PostPartitionSearchOptions builder

    • ddoc

      public PostPartitionSearchOptions.Builder ddoc(String ddoc)
      Set the ddoc.
      Parameters:
      ddoc - the ddoc
      Returns:
      the PostPartitionSearchOptions builder

    • index

      public PostPartitionSearchOptions.Builder index(String index)
      Set the index.
      Parameters:
      index - the index
      Returns:
      the PostPartitionSearchOptions builder

    • query

      public PostPartitionSearchOptions.Builder query(String query)
      Set the query.
      Parameters:
      query - the query
      Returns:
      the PostPartitionSearchOptions builder

    • bookmark

      public PostPartitionSearchOptions.Builder bookmark(String bookmark)
      Set the bookmark.
      Parameters:
      bookmark - the bookmark
      Returns:
      the PostPartitionSearchOptions builder

    • highlightFields

      public PostPartitionSearchOptions.Builder highlightFields(List<String> highlightFields)
      Set the highlightFields. Existing highlightFields will be replaced.
      Parameters:
      highlightFields - the highlightFields
      Returns:
      the PostPartitionSearchOptions builder

    • highlightNumber

      public PostPartitionSearchOptions.Builder highlightNumber(long highlightNumber)
      Set the highlightNumber.
      Parameters:
      highlightNumber - the highlightNumber
      Returns:
      the PostPartitionSearchOptions builder

    • highlightPostTag

      public PostPartitionSearchOptions.Builder highlightPostTag(String highlightPostTag)
      Set the highlightPostTag.
      Parameters:
      highlightPostTag - the highlightPostTag
      Returns:
      the PostPartitionSearchOptions builder

    • highlightPreTag

      public PostPartitionSearchOptions.Builder highlightPreTag(String highlightPreTag)
      Set the highlightPreTag.
      Parameters:
      highlightPreTag - the highlightPreTag
      Returns:
      the PostPartitionSearchOptions builder

    • highlightSize

      public PostPartitionSearchOptions.Builder highlightSize(long highlightSize)
      Set the highlightSize.
      Parameters:
      highlightSize - the highlightSize
      Returns:
      the PostPartitionSearchOptions builder

    • includeDocs

      public PostPartitionSearchOptions.Builder includeDocs(Boolean includeDocs)
      Set the includeDocs.
      Parameters:
      includeDocs - the includeDocs
      Returns:
      the PostPartitionSearchOptions builder

    • includeFields

      public PostPartitionSearchOptions.Builder includeFields(List<String> includeFields)
      Set the includeFields. Existing includeFields will be replaced.
      Parameters:
      includeFields - the includeFields
      Returns:
      the PostPartitionSearchOptions builder

    • limit

      public PostPartitionSearchOptions.Builder limit(long limit)
      Set the limit.
      Parameters:
      limit - the limit
      Returns:
      the PostPartitionSearchOptions builder

    • sort

      public PostPartitionSearchOptions.Builder sort(List<String> sort)
      Set the sort. Existing sort will be replaced.
      Parameters:
      sort - the sort
      Returns:
      the PostPartitionSearchOptions builder

    • stale

      public PostPartitionSearchOptions.Builder stale(String stale)
      Set the stale.
      Parameters:
      stale - the stale
      Returns:
      the PostPartitionSearchOptions builder