Class GetIndexesRequest (2.0.0)

public final class GetIndexesRequest

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();

Inheritance

Object > GetIndexesRequest

Static Methods

newBuilder()

public static final GetIndexesRequest.Builder newBuilder()
Returns
Type Description
GetIndexesRequest.Builder

newBuilder(GetIndexesRequest request)

public static final GetIndexesRequest.Builder newBuilder(GetIndexesRequest request)
Parameter
Name Description
request GetIndexesRequest
Returns
Type Description
GetIndexesRequest.Builder

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getIndexNamePrefix()

public String getIndexNamePrefix()
Returns
Type Description
String

the prefix matching names of all returned indexes

getLimit()

public Integer getLimit()
Returns
Type Description
Integer

the maximum number of indexes returned by this request

getNamespace()

public String getNamespace()
Returns
Type Description
String

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

getOffset()

public Integer getOffset()
Returns
Type Description
Integer

the offset of the first returned index

getStartIndexName()

public String getStartIndexName()
Returns
Type Description
String

the name of the first index to be returned

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

isAllNamespaces()

public Boolean isAllNamespaces()
Returns
Type Description
Boolean

whether or not to return indexes across all namespaces

isIncludeStartIndex()

public boolean isIncludeStartIndex()
Returns
Type Description
boolean

whether or not the index with the start index name is returned

isSchemaFetched()

public Boolean isSchemaFetched()
Returns
Type Description
Boolean

whether or not index schema is returned with each index

toString()

public String toString()
Returns
Type Description
String
Overrides