public static final class Write.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder> implements WriteOrBuilder
A write on a document.Protobuf type
google.firestore.v1beta1.Write| Modifier and Type | Method and Description |
|---|---|
Write.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Write |
build() |
Write |
buildPartial() |
Write.Builder |
clear() |
Write.Builder |
clearCurrentDocument()
An optional precondition on the document.
|
Write.Builder |
clearDelete()
A document name to delete.
|
Write.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Write.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Write.Builder |
clearOperation() |
Write.Builder |
clearTransform()
Applies a transformation to a document.
|
Write.Builder |
clearUpdate()
A document to write.
|
Write.Builder |
clearUpdateMask()
The fields to update in this write.
|
Write.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.
|
Write |
getDefaultInstanceForType() |
String |
getDelete()
A document name to delete.
|
com.google.protobuf.ByteString |
getDeleteBytes()
A document name to delete.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Write.OperationCase |
getOperationCase() |
DocumentTransform |
getTransform()
Applies a transformation to a document.
|
DocumentTransform.Builder |
getTransformBuilder()
Applies a transformation to a document.
|
DocumentTransformOrBuilder |
getTransformOrBuilder()
Applies a transformation to a document.
|
Document |
getUpdate()
A document to write.
|
Document.Builder |
getUpdateBuilder()
A document to write.
|
DocumentMask |
getUpdateMask()
The fields to update in this write.
|
DocumentMask.Builder |
getUpdateMaskBuilder()
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 transformation to a document.
|
boolean |
hasUpdate()
A document to write.
|
boolean |
hasUpdateMask()
The fields to update in this write.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Write.Builder |
mergeCurrentDocument(Precondition value)
An optional precondition on the document.
|
Write.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Write.Builder |
mergeFrom(com.google.protobuf.Message other) |
Write.Builder |
mergeFrom(Write other) |
Write.Builder |
mergeTransform(DocumentTransform value)
Applies a transformation to a document.
|
Write.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Write.Builder |
mergeUpdate(Document value)
A document to write.
|
Write.Builder |
mergeUpdateMask(DocumentMask value)
The fields to update in this write.
|
Write.Builder |
setCurrentDocument(Precondition.Builder builderForValue)
An optional precondition on the document.
|
Write.Builder |
setCurrentDocument(Precondition value)
An optional precondition on the document.
|
Write.Builder |
setDelete(String value)
A document name to delete.
|
Write.Builder |
setDeleteBytes(com.google.protobuf.ByteString value)
A document name to delete.
|
Write.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Write.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Write.Builder |
setTransform(DocumentTransform.Builder builderForValue)
Applies a transformation to a document.
|
Write.Builder |
setTransform(DocumentTransform value)
Applies a transformation to a document.
|
Write.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Write.Builder |
setUpdate(Document.Builder builderForValue)
A document to write.
|
Write.Builder |
setUpdate(Document value)
A document to write.
|
Write.Builder |
setUpdateMask(DocumentMask.Builder builderForValue)
The fields to update in this write.
|
Write.Builder |
setUpdateMask(DocumentMask value)
The fields to update in this write.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public Write.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public Write getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Write build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Write buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Write.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public Write.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public Write.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public Write.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public Write.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public Write.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public Write.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Write.Builder>public Write.Builder mergeFrom(Write other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public Write.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Write.Builder>IOExceptionpublic Write.OperationCase getOperationCase()
getOperationCase in interface WriteOrBuilderpublic Write.Builder clearOperation()
public boolean hasUpdate()
A document to write.
.google.firestore.v1beta1.Document update = 1;hasUpdate in interface WriteOrBuilderpublic Document getUpdate()
A document to write.
.google.firestore.v1beta1.Document update = 1;getUpdate in interface WriteOrBuilderpublic Write.Builder setUpdate(Document value)
A document to write.
.google.firestore.v1beta1.Document update = 1;public Write.Builder setUpdate(Document.Builder builderForValue)
A document to write.
.google.firestore.v1beta1.Document update = 1;public Write.Builder mergeUpdate(Document value)
A document to write.
.google.firestore.v1beta1.Document update = 1;public Write.Builder clearUpdate()
A document to write.
.google.firestore.v1beta1.Document update = 1;public Document.Builder getUpdateBuilder()
A document to write.
.google.firestore.v1beta1.Document update = 1;public DocumentOrBuilder getUpdateOrBuilder()
A document to write.
.google.firestore.v1beta1.Document update = 1;getUpdateOrBuilder in interface WriteOrBuilderpublic String getDelete()
A document name to delete. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
string delete = 2;getDelete in interface WriteOrBuilderpublic 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;getDeleteBytes in interface WriteOrBuilderpublic Write.Builder setDelete(String value)
A document name to delete. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
string delete = 2;public Write.Builder clearDelete()
A document name to delete. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
string delete = 2;public Write.Builder setDeleteBytes(com.google.protobuf.ByteString value)
A document name to delete. In the format:
`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
string delete = 2;public boolean hasTransform()
Applies a transformation 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.v1beta1.DocumentTransform transform = 6;hasTransform in interface WriteOrBuilderpublic DocumentTransform getTransform()
Applies a transformation 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.v1beta1.DocumentTransform transform = 6;getTransform in interface WriteOrBuilderpublic Write.Builder setTransform(DocumentTransform value)
Applies a transformation 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.v1beta1.DocumentTransform transform = 6;public Write.Builder setTransform(DocumentTransform.Builder builderForValue)
Applies a transformation 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.v1beta1.DocumentTransform transform = 6;public Write.Builder mergeTransform(DocumentTransform value)
Applies a transformation 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.v1beta1.DocumentTransform transform = 6;public Write.Builder clearTransform()
Applies a transformation 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.v1beta1.DocumentTransform transform = 6;public DocumentTransform.Builder getTransformBuilder()
Applies a transformation 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.v1beta1.DocumentTransform transform = 6;public DocumentTransformOrBuilder getTransformOrBuilder()
Applies a transformation 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.v1beta1.DocumentTransform transform = 6;getTransformOrBuilder in interface WriteOrBuilderpublic 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.v1beta1.DocumentMask update_mask = 3;hasUpdateMask in interface WriteOrBuilderpublic 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.v1beta1.DocumentMask update_mask = 3;getUpdateMask in interface WriteOrBuilderpublic Write.Builder setUpdateMask(DocumentMask value)
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.v1beta1.DocumentMask update_mask = 3;public Write.Builder setUpdateMask(DocumentMask.Builder builderForValue)
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.v1beta1.DocumentMask update_mask = 3;public Write.Builder mergeUpdateMask(DocumentMask value)
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.v1beta1.DocumentMask update_mask = 3;public Write.Builder clearUpdateMask()
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.v1beta1.DocumentMask update_mask = 3;public DocumentMask.Builder getUpdateMaskBuilder()
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.v1beta1.DocumentMask update_mask = 3;public 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.v1beta1.DocumentMask update_mask = 3;getUpdateMaskOrBuilder in interface WriteOrBuilderpublic 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.v1beta1.Precondition current_document = 4;hasCurrentDocument in interface WriteOrBuilderpublic 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.v1beta1.Precondition current_document = 4;getCurrentDocument in interface WriteOrBuilderpublic Write.Builder setCurrentDocument(Precondition value)
An optional precondition on the document. The write will fail if this is set and not met by the target document.
.google.firestore.v1beta1.Precondition current_document = 4;public Write.Builder setCurrentDocument(Precondition.Builder builderForValue)
An optional precondition on the document. The write will fail if this is set and not met by the target document.
.google.firestore.v1beta1.Precondition current_document = 4;public Write.Builder mergeCurrentDocument(Precondition value)
An optional precondition on the document. The write will fail if this is set and not met by the target document.
.google.firestore.v1beta1.Precondition current_document = 4;public Write.Builder clearCurrentDocument()
An optional precondition on the document. The write will fail if this is set and not met by the target document.
.google.firestore.v1beta1.Precondition current_document = 4;public Precondition.Builder getCurrentDocumentBuilder()
An optional precondition on the document. The write will fail if this is set and not met by the target document.
.google.firestore.v1beta1.Precondition current_document = 4;public 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.v1beta1.Precondition current_document = 4;getCurrentDocumentOrBuilder in interface WriteOrBuilderpublic final Write.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>public final Write.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Write.Builder>Copyright © 2019 Google LLC. All rights reserved.