Send feedback
Class GetIndexRequest.Builder (3.36.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public static final class GetIndexRequest . Builder extends GeneratedMessage . Builder<GetIndexRequest . Builder > implements GetIndexRequestOrBuilder
The request for
FirestoreAdmin.GetIndex .
Protobuf type google.firestore.admin.v1.GetIndexRequest
Inherited Members
com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
build()
public GetIndexRequest build ()
buildPartial()
public GetIndexRequest buildPartial ()
clear()
public GetIndexRequest . Builder clear ()
Overrides
clearName()
public GetIndexRequest . Builder clearName ()
Required. A name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getDefaultInstanceForType()
public GetIndexRequest getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getName()
Required. A name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type
Description
String
The name.
getNameBytes()
public ByteString getNameBytes ()
Required. A name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type
Description
ByteString
The bytes for name.
internalGetFieldAccessorTable()
protected GeneratedMessage . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(GetIndexRequest other)
public GetIndexRequest . Builder mergeFrom ( GetIndexRequest other )
public GetIndexRequest . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public GetIndexRequest . Builder mergeFrom ( Message other )
Parameter
Name
Description
other
Message
Overrides
setName(String value)
public GetIndexRequest . Builder setName ( String value )
Required. A name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter
Name
Description
value
String The name to set.
setNameBytes(ByteString value)
public GetIndexRequest . Builder setNameBytes ( ByteString value )
Required. A name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter
Name
Description
value
ByteString The bytes for name to set.
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 2026-02-01 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-02-01 UTC."],[],[]]