Class GetIndexesRequest.Builder (2.0.0)

public static final class GetIndexesRequest.Builder

The builder of GetIndexesRequests.

Inheritance

java.lang.Object > GetIndexesRequest.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public GetIndexesRequest build()

Returns
Type	Description
GetIndexesRequest	builds and returns a brand new instance of a GetIndexesRequest using values set on this builder

setAllNamespaces(boolean allNamespaces)

public GetIndexesRequest.Builder setAllNamespaces(boolean allNamespaces)

Sets whether or not to fetch indexes from all namespaces.

Parameter
Name	Description
allNamespaces	boolean whether or not to fetch indexes from all namespaces

Returns
Type	Description
GetIndexesRequest.Builder	this builder

setIncludeStartIndex(boolean includeStartIndex)

public GetIndexesRequest.Builder setIncludeStartIndex(boolean includeStartIndex)

Sets whether or not to include the index whose name is specified via the #setStartIndexName(String) method.

Parameter
Name	Description
includeStartIndex	boolean whether or not to return the start index

Returns
Type	Description
GetIndexesRequest.Builder	this builder

setIndexNamePrefix(String indexNamePrefix)

public GetIndexesRequest.Builder setIndexNamePrefix(String indexNamePrefix)

Sets the prefix to be matched against the names of returned indexes. If the prefix is set to, say "a", only indexes with names starting with 'a' will be returned.

Parameter
Name	Description
indexNamePrefix	String the prefix used to select returned indexes

Returns
Type	Description
GetIndexesRequest.Builder	this builder

setLimit(Integer limit)

public GetIndexesRequest.Builder setLimit(Integer limit)

Sets the maximum number of indexes to return.

Parameter
Name	Description
limit	Integer the number of indexes to return

Returns
Type	Description
GetIndexesRequest.Builder	this builder

setNamespace(String namespace)

public GetIndexesRequest.Builder setNamespace(String namespace)

Sets the namespace to use for this request. Only indexes defined within this namespace will be fetched.

Parameter
Name	Description
namespace	String The namespace for this request.

Returns
Type	Description
GetIndexesRequest.Builder	this builder

setOffset(Integer offset)

public GetIndexesRequest.Builder setOffset(Integer offset)

Sets the offset of the first index to return. This method comes with a performance penalty and if you just want to page through all indexes you should consider #setStartIndexName(String) method.

Parameter
Name	Description
offset	Integer the offset of the first returned index

Returns
Type	Description
GetIndexesRequest.Builder	this builder

setSchemaFetched(boolean schemaFetched)

public GetIndexesRequest.Builder setSchemaFetched(boolean schemaFetched)

Sets whether or not the schema is returned with indexes. An index schema is a map from field names to field types.

Parameter
Name	Description
schemaFetched	boolean whether or not schemas are present in returned indexes

Returns
Type	Description
GetIndexesRequest.Builder	this builder

setStartIndexName(String startIndexName)

public GetIndexesRequest.Builder setStartIndexName(String startIndexName)

Sets the name of the first index to return. You may exclude this index by using the #setIncludeStartIndex(boolean) method.

Parameter
Name	Description
startIndexName	String the name of the first index to be returned

Returns
Type	Description
GetIndexesRequest.Builder	this builder