GetIndexesRequest (Google App Engine API for Java)

com.google.appengine.api.search

Class GetIndexesRequest

  • java.lang.Object
    • com.google.appengine.api.search.GetIndexesRequest


  • public final class GetIndexesRequest
    extends java.lang.Object
    A request to get a range of indexes. You can specify a number of restrictions, such as the number of indexes to return, the prefix with which names of the returned indexes must begin, etc. A namespace may be specified, otherwise the default namespace will be used. Only the indexes defined in the namespace, default or otherwise, will be returned.
       GetIndexesRequest request = GetIndexesRequest.newBuilder()
           .setIndexNamePrefix("a")
           .setOffset(100)
           .setLimit(10)
           .build();
     
    • Method Detail

      • getOffset

        public java.lang.Integer getOffset()
        Returns:
        the offset of the first returned index
      • getIndexNamePrefix

        public java.lang.String getIndexNamePrefix()
        Returns:
        the prefix matching names of all returned indexes
      • isIncludeStartIndex

        public boolean isIncludeStartIndex()
        Returns:
        whether or not the index with the start index name is returned
      • getStartIndexName

        public java.lang.String getStartIndexName()
        Returns:
        the name of the first index to be returned
      • getLimit

        public java.lang.Integer getLimit()
        Returns:
        the maximum number of indexes returned by this request
      • isSchemaFetched

        public java.lang.Boolean isSchemaFetched()
        Returns:
        whether or not index schema is returned with each index
      • getNamespace

        public java.lang.String getNamespace()
        Returns:
        the namespace for this request, or null for the default namespace.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

App Engine standard environment for Java