Class Search

  • Direct Known Subclasses:
    SearchFolders

    public class Search
    extends java.lang.Object
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Api api  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Search aggregate​(java.lang.String field)  
      ApiResponse execute()  
      Search expression​(java.lang.String value)  
      Search maxResults​(java.lang.Integer value)  
      Search nextCursor​(java.lang.String value)  
      Search sortBy​(java.lang.String field, java.lang.String dir)  
      java.util.HashMap<java.lang.String,​java.lang.Object> toQuery()  
      java.lang.String toUrl()  
      java.lang.String toUrl​(java.lang.Integer ttl, java.lang.String nextCursor)
      Creates a signed Search URL that can be used on the client side.
      java.lang.String toUrl​(java.lang.String nextCursor)  
      Search ttl​(int ttl)  
      Search withField​(java.lang.String field)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • api

        protected final Api api
    • Method Detail

      • ttl

        public Search ttl​(int ttl)
      • expression

        public Search expression​(java.lang.String value)
      • maxResults

        public Search maxResults​(java.lang.Integer value)
      • nextCursor

        public Search nextCursor​(java.lang.String value)
      • aggregate

        public Search aggregate​(java.lang.String field)
      • withField

        public Search withField​(java.lang.String field)
      • sortBy

        public Search sortBy​(java.lang.String field,
                             java.lang.String dir)
      • toQuery

        public java.util.HashMap<java.lang.String,​java.lang.Object> toQuery()
      • execute

        public ApiResponse execute()
                            throws java.lang.Exception
        Throws:
        java.lang.Exception
      • toUrl

        public java.lang.String toUrl()
                               throws java.lang.Exception
        Throws:
        java.lang.Exception
      • toUrl

        public java.lang.String toUrl​(java.lang.String nextCursor)
                               throws java.lang.Exception
        Throws:
        java.lang.Exception
      • toUrl

        public java.lang.String toUrl​(java.lang.Integer ttl,
                                      java.lang.String nextCursor)
                               throws java.lang.Exception
        Creates a signed Search URL that can be used on the client side.
        Throws:
        java.lang.Exception