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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GetFieldRequest.BuilderImplements
GetFieldRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GetFieldRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
build()
public GetFieldRequest build()
Returns | |
---|---|
Type | Description |
GetFieldRequest |
buildPartial()
public GetFieldRequest buildPartial()
Returns | |
---|---|
Type | Description |
GetFieldRequest |
clear()
public GetFieldRequest.Builder clear()
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public GetFieldRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
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 | |
---|---|
Type | Description |
GetFieldRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public GetFieldRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
clone()
public GetFieldRequest.Builder clone()
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
getDefaultInstanceForType()
public GetFieldRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
GetFieldRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString | The bytes for name. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(GetFieldRequest other)
public GetFieldRequest.Builder mergeFrom(GetFieldRequest other)
Parameter | |
---|---|
Name | Description |
other | GetFieldRequest |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GetFieldRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public GetFieldRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GetFieldRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public GetFieldRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
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 | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final GetFieldRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
GetFieldRequest.Builder |