Send feedback
Class UpdateFieldRequest.Builder (3.3.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.3.0 keyboard_arrow_down
public static final class UpdateFieldRequest . Builder extends GeneratedMessageV3 . Builder<UpdateFieldRequest . Builder > implements UpdateFieldRequestOrBuilder
The request for FirestoreAdmin.UpdateField .
Protobuf type google.firestore.admin.v1.UpdateFieldRequest
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UpdateFieldRequest . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
build()
public UpdateFieldRequest build ()
Returns
buildPartial()
public UpdateFieldRequest buildPartial ()
Returns
clear()
public UpdateFieldRequest . Builder clear ()
Returns
Overrides
clearField()
public UpdateFieldRequest . Builder clearField ()
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
clearField(Descriptors.FieldDescriptor field)
public UpdateFieldRequest . Builder clearField ( Descriptors . FieldDescriptor field )
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public UpdateFieldRequest . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Parameter
Returns
Overrides
clearUpdateMask()
public UpdateFieldRequest . Builder clearUpdateMask ()
A mask, relative to the field. If specified, only configuration specified
by this field_mask will be updated in the field.
.google.protobuf.FieldMask update_mask = 2;
Returns
clone()
public UpdateFieldRequest . Builder clone ()
Returns
Overrides
getDefaultInstanceForType()
public UpdateFieldRequest getDefaultInstanceForType ()
Returns
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Returns
Overrides
getField()
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description Field The field.
getFieldBuilder()
public Field . Builder getFieldBuilder ()
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
getFieldOrBuilder()
public FieldOrBuilder getFieldOrBuilder ()
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
getUpdateMask()
public FieldMask getUpdateMask ()
A mask, relative to the field. If specified, only configuration specified
by this field_mask will be updated in the field.
.google.protobuf.FieldMask update_mask = 2;
Returns
getUpdateMaskBuilder()
public FieldMask . Builder getUpdateMaskBuilder ()
A mask, relative to the field. If specified, only configuration specified
by this field_mask will be updated in the field.
.google.protobuf.FieldMask update_mask = 2;
Returns
getUpdateMaskOrBuilder()
public FieldMaskOrBuilder getUpdateMaskOrBuilder ()
A mask, relative to the field. If specified, only configuration specified
by this field_mask will be updated in the field.
.google.protobuf.FieldMask update_mask = 2;
Returns
hasField()
public boolean hasField ()
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description boolean Whether the field field is set.
hasUpdateMask()
public boolean hasUpdateMask ()
A mask, relative to the field. If specified, only configuration specified
by this field_mask will be updated in the field.
.google.protobuf.FieldMask update_mask = 2;
Returns
Type Description boolean Whether the updateMask field is set.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
mergeField(Field value)
public UpdateFieldRequest . Builder mergeField ( Field value )
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name Description value Field
Returns
mergeFrom(UpdateFieldRequest other)
public UpdateFieldRequest . Builder mergeFrom ( UpdateFieldRequest other )
Parameter
Returns
public UpdateFieldRequest . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public UpdateFieldRequest . Builder mergeFrom ( Message other )
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UpdateFieldRequest . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
mergeUpdateMask(FieldMask value)
public UpdateFieldRequest . Builder mergeUpdateMask ( FieldMask value )
A mask, relative to the field. If specified, only configuration specified
by this field_mask will be updated in the field.
.google.protobuf.FieldMask update_mask = 2;
Parameter
Returns
setField(Field value)
public UpdateFieldRequest . Builder setField ( Field value )
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name Description value Field
Returns
setField(Field.Builder builderForValue)
public UpdateFieldRequest . Builder setField ( Field . Builder builderForValue )
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public UpdateFieldRequest . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UpdateFieldRequest . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final UpdateFieldRequest . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
setUpdateMask(FieldMask value)
public UpdateFieldRequest . Builder setUpdateMask ( FieldMask value )
A mask, relative to the field. If specified, only configuration specified
by this field_mask will be updated in the field.
.google.protobuf.FieldMask update_mask = 2;
Parameter
Returns
setUpdateMask(FieldMask.Builder builderForValue)
public UpdateFieldRequest . Builder setUpdateMask ( FieldMask . Builder builderForValue )
A mask, relative to the field. If specified, only configuration specified
by this field_mask will be updated in the field.
.google.protobuf.FieldMask update_mask = 2;
Parameter
Name Description builderForValue Builder
Returns
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 2025-01-28 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 2025-01-28 UTC."],[],[]]
