Package com.google.appengine.api.search

Class GetIndexesRequest

java.lang.Object

com.google.appengine.api.search.GetIndexesRequest

public final class GetIndexesRequest
extends 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetIndexesRequest.Builder	The builder of GetIndexesRequests.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getIndexNamePrefix()
Integer	getLimit()
String	getNamespace()
Integer	getOffset()
String	getStartIndexName()
int	hashCode()
Boolean	isAllNamespaces()
boolean	isIncludeStartIndex()
Boolean	isSchemaFetched()
static GetIndexesRequest.Builder	newBuilder()
static GetIndexesRequest.Builder	newBuilder(GetIndexesRequest request)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public static final GetIndexesRequest.Builder newBuilder()

newBuilder

public static final GetIndexesRequest.Builder newBuilder(GetIndexesRequest request)

getOffset

public Integer getOffset()

Returns:

the offset of the first returned index

getIndexNamePrefix

public 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 String getStartIndexName()

Returns:

the name of the first index to be returned

getLimit

public Integer getLimit()

Returns:

the maximum number of indexes returned by this request

isSchemaFetched

public Boolean isSchemaFetched()

Returns:

whether or not index schema is returned with each index

getNamespace

public String getNamespace()

Returns:

the namespace for this request, or null for the default namespace.

isAllNamespaces

public Boolean isAllNamespaces()

Returns:

whether or not to return indexes across all namespaces

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object