Class GetFieldRequest.Builder (3.5.0)

public static final class GetFieldRequest.Builder extends GeneratedMessageV3.Builder<GetFieldRequest.Builder> implements GetFieldRequestOrBuilder

The request for FirestoreAdmin.GetField.

Protobuf type google.firestore.admin.v1.GetFieldRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GetFieldRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GetFieldRequest.Builder
Overrides

build()

public GetFieldRequest build()
Returns
TypeDescription
GetFieldRequest

buildPartial()

public GetFieldRequest buildPartial()
Returns
TypeDescription
GetFieldRequest

clear()

public GetFieldRequest.Builder clear()
Returns
TypeDescription
GetFieldRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public GetFieldRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
GetFieldRequest.Builder
Overrides

clearName()

public GetFieldRequest.Builder clearName()

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
GetFieldRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GetFieldRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
GetFieldRequest.Builder
Overrides

clone()

public GetFieldRequest.Builder clone()
Returns
TypeDescription
GetFieldRequest.Builder
Overrides

getDefaultInstanceForType()

public GetFieldRequest getDefaultInstanceForType()
Returns
TypeDescription
GetFieldRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getName()

public String getName()

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(GetFieldRequest other)

public GetFieldRequest.Builder mergeFrom(GetFieldRequest other)
Parameter
NameDescription
otherGetFieldRequest
Returns
TypeDescription
GetFieldRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetFieldRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GetFieldRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public GetFieldRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
GetFieldRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GetFieldRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GetFieldRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GetFieldRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GetFieldRequest.Builder
Overrides

setName(String value)

public GetFieldRequest.Builder setName(String value)

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
GetFieldRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetFieldRequest.Builder setNameBytes(ByteString value)

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
GetFieldRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GetFieldRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
GetFieldRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GetFieldRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GetFieldRequest.Builder
Overrides