Class ExplainResultOpts

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.cloudant.v1.model.ExplainResultOpts
All Implemented Interfaces:
ObjectModel
public class ExplainResultOpts extends GenericModel
Options used for the request.

  • Method Details

    • getBookmark

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

    • isConflicts

      public Boolean isConflicts()
      Gets the conflicts. Conflicts used in the request query.
      Returns:
      the conflicts

    • isExecutionStats

      public Boolean isExecutionStats()
      Gets the executionStats. Execution statistics used in the request query.
      Returns:
      the executionStats

    • getFields

      public List<String> getFields()
      Gets the fields. JSON array that uses the field syntax. Use this parameter to specify which fields of a document must be returned. If it is omitted or empty, the entire document is returned.
      Returns:
      the fields

    • getLimit

      public Long getLimit()
      Gets the limit. Limit used in the request query.
      Returns:
      the limit

    • getPartition

      public String getPartition()
      Gets the partition. On which database partition the request was used. If it was not used on a database partition, it returns with `""`.
      Returns:
      the partition

    • getR

      public Long getR()
      Gets the r. The read quorum that is needed for the result.
      Returns:
      the r

    • getSkip

      public Long getSkip()
      Gets the skip. Skip used in the request query.
      Returns:
      the skip

    • getSort

      public Object getSort()
      Gets the sort. Schema for any JSON type.
      Returns:
      the sort

    • isStable

      public Boolean isStable()
      Gets the stable. Stable used in the request query.
      Returns:
      the stable

    • isStale

      @Deprecated public Boolean isStale()
      Deprecated.
      this method is deprecated and may be removed in a future release
      Gets the stale. Stale used in the request query.
      Returns:
      the stale

    • isUpdate

      public Boolean isUpdate()
      Gets the update. Update used in the request query.
      Returns:
      the update

    • getUseIndex

      public List<String> getUseIndex()
      Gets the useIndex. Use index used in the request query.
      Returns:
      the useIndex