Class UpdateFieldRequest (3.14.4)
3.38.0 (latest)
3.37.0
3.36.0
3.35.1
3.33.4
3.32.2
3.31.9
3.30.11
3.28.0
3.27.2
3.26.5
3.25.1
3.24.3
3.22.0
3.21.4
3.20.0
3.17.0
3.16.3
3.15.7
3.14.4
3.13.2
3.12.1
3.11.0
3.10.0
3.9.6
3.8.2
3.7.10
3.6.0
3.5.0
3.4.2
3.3.0
3.2.0
3.1.0
3.0.21
public final class UpdateFieldRequest extends GeneratedMessageV3 implements UpdateFieldRequestOrBuilder
The request for
FirestoreAdmin.UpdateField .
Protobuf type google.firestore.admin.v1.UpdateFieldRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
FIELD_FIELD_NUMBER
public static final int FIELD_FIELD_NUMBER
Field Value
Type Description
int
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static UpdateFieldRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static UpdateFieldRequest . Builder newBuilder ()
newBuilder(UpdateFieldRequest prototype)
public static UpdateFieldRequest . Builder newBuilder ( UpdateFieldRequest prototype )
public static UpdateFieldRequest parseDelimitedFrom ( InputStream input )
public static UpdateFieldRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static UpdateFieldRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateFieldRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static UpdateFieldRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateFieldRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static UpdateFieldRequest parseFrom ( CodedInputStream input )
public static UpdateFieldRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static UpdateFieldRequest parseFrom ( InputStream input )
public static UpdateFieldRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static UpdateFieldRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateFieldRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<UpdateFieldRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public UpdateFieldRequest getDefaultInstanceForType ()
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.
getFieldOrBuilder()
public FieldOrBuilder getFieldOrBuilder ()
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
getParserForType()
public Parser<UpdateFieldRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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
Type Description
FieldMask The updateMask.
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;
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public UpdateFieldRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateFieldRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public UpdateFieldRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
