Send feedback
Class GetIndexesRequest (2.0.0)
Stay organized with collections
Save and categorize content based on your preferences.
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()
newBuilder(GetIndexesRequest request)
public static final GetIndexesRequest.Builder newBuilder(GetIndexesRequest request)
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter Name Description obj
Object
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()
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()
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-06-20 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?