Send feedback
Class UpdateDocumentRequest (3.15.3)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.15.3 keyboard_arrow_down
public final class UpdateDocumentRequest extends GeneratedMessageV3 implements UpdateDocumentRequestOrBuilder
The request for
Firestore.UpdateDocument .
Protobuf type google.firestore.v1.UpdateDocumentRequest
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
CURRENT_DOCUMENT_FIELD_NUMBER
public static final int CURRENT_DOCUMENT_FIELD_NUMBER
Field Value Type Description int
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
Field Value Type Description int
MASK_FIELD_NUMBER
public static final int MASK_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 UpdateDocumentRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static UpdateDocumentRequest . Builder newBuilder ()
newBuilder(UpdateDocumentRequest prototype)
public static UpdateDocumentRequest . Builder newBuilder ( UpdateDocumentRequest prototype )
public static UpdateDocumentRequest parseDelimitedFrom ( InputStream input )
public static UpdateDocumentRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static UpdateDocumentRequest parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateDocumentRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static UpdateDocumentRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateDocumentRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static UpdateDocumentRequest parseFrom ( CodedInputStream input )
public static UpdateDocumentRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static UpdateDocumentRequest parseFrom ( InputStream input )
public static UpdateDocumentRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static UpdateDocumentRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateDocumentRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<UpdateDocumentRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getCurrentDocument()
public Precondition getCurrentDocument ()
An optional precondition on the document.
The request will fail if this is set and not met by the target document.
.google.firestore.v1.Precondition current_document = 4;
getCurrentDocumentOrBuilder()
public PreconditionOrBuilder getCurrentDocumentOrBuilder ()
An optional precondition on the document.
The request will fail if this is set and not met by the target document.
.google.firestore.v1.Precondition current_document = 4;
getDefaultInstanceForType()
public UpdateDocumentRequest getDefaultInstanceForType ()
getDocument()
public Document getDocument ()
Required. The updated document.
Creates the document if it does not already exist.
.google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
Returns Type Description Document The document.
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder ()
Required. The updated document.
Creates the document if it does not already exist.
.google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
getMask()
public DocumentMask getMask ()
The fields to return. If not set, returns all fields.
If the document has a field that is not present in this mask, that field
will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;
getMaskOrBuilder()
public DocumentMaskOrBuilder getMaskOrBuilder ()
The fields to return. If not set, returns all fields.
If the document has a field that is not present in this mask, that field
will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;
getParserForType()
public Parser<UpdateDocumentRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
getUpdateMask()
public DocumentMask getUpdateMask ()
The fields to update.
None of the field paths in the mask may contain a reserved name.
If the document exists on the server and has fields not referenced in the
mask, they are left unchanged.
Fields referenced in the mask, but not present in the input document, are
deleted from the document on the server.
.google.firestore.v1.DocumentMask update_mask = 2;
getUpdateMaskOrBuilder()
public DocumentMaskOrBuilder getUpdateMaskOrBuilder ()
The fields to update.
None of the field paths in the mask may contain a reserved name.
If the document exists on the server and has fields not referenced in the
mask, they are left unchanged.
Fields referenced in the mask, but not present in the input document, are
deleted from the document on the server.
.google.firestore.v1.DocumentMask update_mask = 2;
hasCurrentDocument()
public boolean hasCurrentDocument ()
An optional precondition on the document.
The request will fail if this is set and not met by the target document.
.google.firestore.v1.Precondition current_document = 4;
Returns Type Description boolean Whether the currentDocument field is set.
hasDocument()
public boolean hasDocument ()
Required. The updated document.
Creates the document if it does not already exist.
.google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
Returns Type Description boolean Whether the document field is set.
hasMask()
The fields to return. If not set, returns all fields.
If the document has a field that is not present in this mask, that field
will not be returned in the response.
.google.firestore.v1.DocumentMask mask = 3;
Returns Type Description boolean Whether the mask field is set.
hasUpdateMask()
public boolean hasUpdateMask ()
The fields to update.
None of the field paths in the mask may contain a reserved name.
If the document exists on the server and has fields not referenced in the
mask, they are left unchanged.
Fields referenced in the mask, but not present in the input document, are
deleted from the document on the server.
.google.firestore.v1.DocumentMask 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 UpdateDocumentRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateDocumentRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public UpdateDocumentRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-27 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-27 UTC."],[],[]]
