Class SearchObjectsOptions

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel

    public class SearchObjectsOptions
    extends com.ibm.cloud.sdk.core.service.model.GenericModel
    The searchObjects options.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Boolean collapse()
      Gets the collapse.
      java.lang.Boolean digest()
      Gets the digest.
      java.lang.Long limit()
      Gets the limit.
      SearchObjectsOptions.Builder newBuilder()
      New builder.
      java.lang.Long offset()
      Gets the offset.
      java.lang.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

      • query

        public java.lang.String query()
        Gets the query. Lucene query string.
        Returns:
        the query
      • limit

        public java.lang.Long limit()
        Gets the limit. The maximum number of results to return.
        Returns:
        the limit
      • offset

        public java.lang.Long offset()
        Gets the offset. The number of results to skip before returning values.
        Returns:
        the offset
      • collapse

        public java.lang.Boolean collapse()
        Gets the collapse. When true, hide private objects that correspond to public or IBM published objects.
        Returns:
        the collapse
      • digest

        public java.lang.Boolean digest()
        Gets the digest. Display a digests of search results, has default value of true.
        Returns:
        the digest