com.google.firestore.v1

Class UpdateDocumentRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

com.google.firestore.v1.UpdateDocumentRequest.Builder

All Implemented Interfaces:

UpdateDocumentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

UpdateDocumentRequest

public static final class UpdateDocumentRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>
implements UpdateDocumentRequestOrBuilder

 The request for
 [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].
 

Protobuf type google.firestore.v1.UpdateDocumentRequest

Method Summary

Modifier and Type	Method and Description
UpdateDocumentRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
UpdateDocumentRequest	build()
UpdateDocumentRequest	buildPartial()
UpdateDocumentRequest.Builder	clear()
UpdateDocumentRequest.Builder	clearCurrentDocument() An optional precondition on the document.
UpdateDocumentRequest.Builder	clearDocument() Required.
UpdateDocumentRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
UpdateDocumentRequest.Builder	clearMask() The fields to return.
UpdateDocumentRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
UpdateDocumentRequest.Builder	clearUpdateMask() The fields to update.
UpdateDocumentRequest.Builder	clone()
Precondition	getCurrentDocument() An optional precondition on the document.
Precondition.Builder	getCurrentDocumentBuilder() An optional precondition on the document.
PreconditionOrBuilder	getCurrentDocumentOrBuilder() An optional precondition on the document.
UpdateDocumentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Document	getDocument() Required.
Document.Builder	getDocumentBuilder() Required.
DocumentOrBuilder	getDocumentOrBuilder() Required.
DocumentMask	getMask() The fields to return.
DocumentMask.Builder	getMaskBuilder() The fields to return.
DocumentMaskOrBuilder	getMaskOrBuilder() The fields to return.
DocumentMask	getUpdateMask() The fields to update.
DocumentMask.Builder	getUpdateMaskBuilder() The fields to update.
DocumentMaskOrBuilder	getUpdateMaskOrBuilder() The fields to update.
boolean	hasCurrentDocument() An optional precondition on the document.
boolean	hasDocument() Required.
boolean	hasMask() The fields to return.
boolean	hasUpdateMask() The fields to update.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
UpdateDocumentRequest.Builder	mergeCurrentDocument(Precondition value) An optional precondition on the document.
UpdateDocumentRequest.Builder	mergeDocument(Document value) Required.
UpdateDocumentRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
UpdateDocumentRequest.Builder	mergeFrom(com.google.protobuf.Message other)
UpdateDocumentRequest.Builder	mergeFrom(UpdateDocumentRequest other)
UpdateDocumentRequest.Builder	mergeMask(DocumentMask value) The fields to return.
UpdateDocumentRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
UpdateDocumentRequest.Builder	mergeUpdateMask(DocumentMask value) The fields to update.
UpdateDocumentRequest.Builder	setCurrentDocument(Precondition.Builder builderForValue) An optional precondition on the document.
UpdateDocumentRequest.Builder	setCurrentDocument(Precondition value) An optional precondition on the document.
UpdateDocumentRequest.Builder	setDocument(Document.Builder builderForValue) Required.
UpdateDocumentRequest.Builder	setDocument(Document value) Required.
UpdateDocumentRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
UpdateDocumentRequest.Builder	setMask(DocumentMask.Builder builderForValue) The fields to return.
UpdateDocumentRequest.Builder	setMask(DocumentMask value) The fields to return.
UpdateDocumentRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
UpdateDocumentRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
UpdateDocumentRequest.Builder	setUpdateMask(DocumentMask.Builder builderForValue) The fields to update.
UpdateDocumentRequest.Builder	setUpdateMask(DocumentMask value) The fields to update.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

clear

public UpdateDocumentRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

getDefaultInstanceForType

public UpdateDocumentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public UpdateDocumentRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public UpdateDocumentRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public UpdateDocumentRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

setField

public UpdateDocumentRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

clearField

public UpdateDocumentRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

clearOneof

public UpdateDocumentRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

setRepeatedField

public UpdateDocumentRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

addRepeatedField

public UpdateDocumentRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

mergeFrom

public UpdateDocumentRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UpdateDocumentRequest.Builder>

mergeFrom

public UpdateDocumentRequest.Builder mergeFrom(UpdateDocumentRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

mergeFrom

public UpdateDocumentRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UpdateDocumentRequest.Builder>

Throws:

IOException

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];

Specified by:

hasDocument in interface UpdateDocumentRequestOrBuilder

Returns:

Whether the document field is set.

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];

Specified by:

getDocument in interface UpdateDocumentRequestOrBuilder

Returns:

The document.

setDocument

public UpdateDocumentRequest.Builder setDocument(Document value)

 Required. The updated document.
 Creates the document if it does not already exist.
 

.google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

setDocument

public UpdateDocumentRequest.Builder setDocument(Document.Builder builderForValue)

 Required. The updated document.
 Creates the document if it does not already exist.
 

.google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

mergeDocument

public UpdateDocumentRequest.Builder mergeDocument(Document value)

 Required. The updated document.
 Creates the document if it does not already exist.
 

.google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

clearDocument

public UpdateDocumentRequest.Builder clearDocument()

 Required. The updated document.
 Creates the document if it does not already exist.
 

.google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

getDocumentBuilder

public Document.Builder getDocumentBuilder()

 Required. The updated document.
 Creates the document if it does not already exist.
 

.google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];

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];

Specified by:

getDocumentOrBuilder in interface UpdateDocumentRequestOrBuilder

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;

Specified by:

hasUpdateMask in interface UpdateDocumentRequestOrBuilder

Returns:

Whether the updateMask field is set.

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;

Specified by:

getUpdateMask in interface UpdateDocumentRequestOrBuilder

Returns:

The updateMask.

setUpdateMask

public UpdateDocumentRequest.Builder setUpdateMask(DocumentMask value)

 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;

setUpdateMask

public UpdateDocumentRequest.Builder setUpdateMask(DocumentMask.Builder builderForValue)

 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;

mergeUpdateMask

public UpdateDocumentRequest.Builder mergeUpdateMask(DocumentMask value)

 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;

clearUpdateMask

public UpdateDocumentRequest.Builder clearUpdateMask()

 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;

getUpdateMaskBuilder

public DocumentMask.Builder getUpdateMaskBuilder()

 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;

Specified by:

getUpdateMaskOrBuilder in interface UpdateDocumentRequestOrBuilder

hasMask

public boolean 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;

Specified by:

hasMask in interface UpdateDocumentRequestOrBuilder

Returns:

Whether the mask field is set.

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;

Specified by:

getMask in interface UpdateDocumentRequestOrBuilder

Returns:

The mask.

setMask

public UpdateDocumentRequest.Builder setMask(DocumentMask value)

 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;

setMask

public UpdateDocumentRequest.Builder setMask(DocumentMask.Builder builderForValue)

 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;

mergeMask

public UpdateDocumentRequest.Builder mergeMask(DocumentMask value)

 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;

clearMask

public UpdateDocumentRequest.Builder clearMask()

 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;

getMaskBuilder

public DocumentMask.Builder getMaskBuilder()

 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;

Specified by:

getMaskOrBuilder in interface UpdateDocumentRequestOrBuilder

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;

Specified by:

hasCurrentDocument in interface UpdateDocumentRequestOrBuilder

Returns:

Whether the currentDocument field is set.

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;

Specified by:

getCurrentDocument in interface UpdateDocumentRequestOrBuilder

Returns:

The currentDocument.

setCurrentDocument

public UpdateDocumentRequest.Builder setCurrentDocument(Precondition value)

 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;

setCurrentDocument

public UpdateDocumentRequest.Builder setCurrentDocument(Precondition.Builder builderForValue)

 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;

mergeCurrentDocument

public UpdateDocumentRequest.Builder mergeCurrentDocument(Precondition value)

 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;

clearCurrentDocument

public UpdateDocumentRequest.Builder clearCurrentDocument()

 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;

getCurrentDocumentBuilder

public Precondition.Builder getCurrentDocumentBuilder()

 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;

Specified by:

getCurrentDocumentOrBuilder in interface UpdateDocumentRequestOrBuilder

setUnknownFields

public final UpdateDocumentRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>

mergeUnknownFields

public final UpdateDocumentRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UpdateDocumentRequest.Builder>