Class GetIndexRequest.Builder (3.36.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public GetIndexRequest build()
Returns
Type Description
GetIndexRequest

buildPartial()

public GetIndexRequest buildPartial()
Returns
Type Description
GetIndexRequest

clear()

public GetIndexRequest.Builder clear()
Returns
Type Description
GetIndexRequest.Builder
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) = { ... }

Returns
Type Description
GetIndexRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public GetIndexRequest getDefaultInstanceForType()
Returns
Type Description
GetIndexRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String 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()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GetIndexRequest other)

public GetIndexRequest.Builder mergeFrom(GetIndexRequest other)
Parameter
Name Description
other GetIndexRequest
Returns
Type Description
GetIndexRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetIndexRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetIndexRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GetIndexRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GetIndexRequest.Builder
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.

Returns
Type Description
GetIndexRequest.Builder

This builder for chaining.

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.

Returns
Type Description
GetIndexRequest.Builder

This builder for chaining.