com.google.firestore.v1

Interface WriteOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Write, Write.Builder

public interface WriteOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Precondition	getCurrentDocument() An optional precondition on the document.
PreconditionOrBuilder	getCurrentDocumentOrBuilder() An optional precondition on the document.
String	getDelete() A document name to delete.
com.google.protobuf.ByteString	getDeleteBytes() A document name to delete.
Write.OperationCase	getOperationCase()
DocumentTransform	getTransform() Applies a tranformation to a document.
DocumentTransformOrBuilder	getTransformOrBuilder() Applies a tranformation to a document.
Document	getUpdate() A document to write.
DocumentMask	getUpdateMask() The fields to update in this write.
DocumentMaskOrBuilder	getUpdateMaskOrBuilder() The fields to update in this write.
DocumentOrBuilder	getUpdateOrBuilder() A document to write.
boolean	hasCurrentDocument() An optional precondition on the document.
boolean	hasTransform() Applies a tranformation to a document.
boolean	hasUpdate() A document to write.
boolean	hasUpdateMask() The fields to update in this write.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasUpdate

boolean hasUpdate()

 A document to write.
 

.google.firestore.v1.Document update = 1;

getUpdate

Document getUpdate()

 A document to write.
 

.google.firestore.v1.Document update = 1;

getUpdateOrBuilder

DocumentOrBuilder getUpdateOrBuilder()

 A document to write.
 

.google.firestore.v1.Document update = 1;

getDelete

String getDelete()

 A document name to delete. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 

string delete = 2;

getDeleteBytes

com.google.protobuf.ByteString getDeleteBytes()

 A document name to delete. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 

string delete = 2;

hasTransform

boolean hasTransform()

 Applies a tranformation to a document.
 At most one `transform` per document is allowed in a given request.
 An `update` cannot follow a `transform` on the same document in a given
 request.
 

.google.firestore.v1.DocumentTransform transform = 6;

getTransform

DocumentTransform getTransform()

 Applies a tranformation to a document.
 At most one `transform` per document is allowed in a given request.
 An `update` cannot follow a `transform` on the same document in a given
 request.
 

.google.firestore.v1.DocumentTransform transform = 6;

getTransformOrBuilder

DocumentTransformOrBuilder getTransformOrBuilder()

 Applies a tranformation to a document.
 At most one `transform` per document is allowed in a given request.
 An `update` cannot follow a `transform` on the same document in a given
 request.
 

.google.firestore.v1.DocumentTransform transform = 6;

hasUpdateMask

boolean hasUpdateMask()

 The fields to update in this write.
 This field can be set only when the operation is `update`.
 If the mask is not set for an `update` and the document exists, any
 existing data will be overwritten.
 If the mask is set and the document on the server has fields not covered by
 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.
 The field paths in this mask must not contain a reserved field name.
 

.google.firestore.v1.DocumentMask update_mask = 3;

getUpdateMask

DocumentMask getUpdateMask()

 The fields to update in this write.
 This field can be set only when the operation is `update`.
 If the mask is not set for an `update` and the document exists, any
 existing data will be overwritten.
 If the mask is set and the document on the server has fields not covered by
 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.
 The field paths in this mask must not contain a reserved field name.
 

.google.firestore.v1.DocumentMask update_mask = 3;

getUpdateMaskOrBuilder

DocumentMaskOrBuilder getUpdateMaskOrBuilder()

 The fields to update in this write.
 This field can be set only when the operation is `update`.
 If the mask is not set for an `update` and the document exists, any
 existing data will be overwritten.
 If the mask is set and the document on the server has fields not covered by
 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.
 The field paths in this mask must not contain a reserved field name.
 

.google.firestore.v1.DocumentMask update_mask = 3;

hasCurrentDocument

boolean hasCurrentDocument()

 An optional precondition on the document.
 The write will fail if this is set and not met by the target document.
 

.google.firestore.v1.Precondition current_document = 4;

getCurrentDocument

Precondition getCurrentDocument()

 An optional precondition on the document.
 The write will fail if this is set and not met by the target document.
 

.google.firestore.v1.Precondition current_document = 4;

getCurrentDocumentOrBuilder

PreconditionOrBuilder getCurrentDocumentOrBuilder()

 An optional precondition on the document.
 The write will fail if this is set and not met by the target document.
 

.google.firestore.v1.Precondition current_document = 4;

getOperationCase

Write.OperationCase getOperationCase()