com.google.firestore.v1.WriteOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-firestore-v1 Show documentation
Show all versions of proto-google-cloud-firestore-v1 Show documentation
PROTO library for proto-google-cloud-firestore-v1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/firestore/v1/write.proto
// Protobuf Java Version: 3.25.4
package com.google.firestore.v1;
public interface WriteOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.firestore.v1.Write)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* A document to write.
*
*
* .google.firestore.v1.Document update = 1;
*
* @return Whether the update field is set.
*/
boolean hasUpdate();
/**
*
*
*
* A document to write.
*
*
* .google.firestore.v1.Document update = 1;
*
* @return The update.
*/
com.google.firestore.v1.Document getUpdate();
/**
*
*
*
* A document to write.
*
*
* .google.firestore.v1.Document update = 1;
*/
com.google.firestore.v1.DocumentOrBuilder getUpdateOrBuilder();
/**
*
*
*
* A document name to delete. In the format:
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
*
* string delete = 2;
*
* @return Whether the delete field is set.
*/
boolean hasDelete();
/**
*
*
*
* A document name to delete. In the format:
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
*
* string delete = 2;
*
* @return The delete.
*/
java.lang.String getDelete();
/**
*
*
*
* A document name to delete. In the format:
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
*
* string delete = 2;
*
* @return The bytes for delete.
*/
com.google.protobuf.ByteString getDeleteBytes();
/**
*
*
*
* Applies a transformation to a document.
*
*
* .google.firestore.v1.DocumentTransform transform = 6;
*
* @return Whether the transform field is set.
*/
boolean hasTransform();
/**
*
*
*
* Applies a transformation to a document.
*
*
* .google.firestore.v1.DocumentTransform transform = 6;
*
* @return The transform.
*/
com.google.firestore.v1.DocumentTransform getTransform();
/**
*
*
*
* Applies a transformation to a document.
*
*
* .google.firestore.v1.DocumentTransform transform = 6;
*/
com.google.firestore.v1.DocumentTransformOrBuilder getTransformOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the updateMask field is set.
*/
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;
*
* @return The updateMask.
*/
com.google.firestore.v1.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;
*/
com.google.firestore.v1.DocumentMaskOrBuilder getUpdateMaskOrBuilder();
/**
*
*
*
* The transforms to perform after update.
*
* This field can be set only when the operation is `update`. If present, this
* write is equivalent to performing `update` and `transform` to the same
* document atomically and in order.
*
*
* repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;
*
*/
java.util.List
getUpdateTransformsList();
/**
*
*
*
* The transforms to perform after update.
*
* This field can be set only when the operation is `update`. If present, this
* write is equivalent to performing `update` and `transform` to the same
* document atomically and in order.
*
*
* repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;
*
*/
com.google.firestore.v1.DocumentTransform.FieldTransform getUpdateTransforms(int index);
/**
*
*
*
* The transforms to perform after update.
*
* This field can be set only when the operation is `update`. If present, this
* write is equivalent to performing `update` and `transform` to the same
* document atomically and in order.
*
*
* repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;
*
*/
int getUpdateTransformsCount();
/**
*
*
*
* The transforms to perform after update.
*
* This field can be set only when the operation is `update`. If present, this
* write is equivalent to performing `update` and `transform` to the same
* document atomically and in order.
*
*
* repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;
*
*/
java.util.List
getUpdateTransformsOrBuilderList();
/**
*
*
*
* The transforms to perform after update.
*
* This field can be set only when the operation is `update`. If present, this
* write is equivalent to performing `update` and `transform` to the same
* document atomically and in order.
*
*
* repeated .google.firestore.v1.DocumentTransform.FieldTransform update_transforms = 7;
*
*/
com.google.firestore.v1.DocumentTransform.FieldTransformOrBuilder getUpdateTransformsOrBuilder(
int index);
/**
*
*
*
* 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;
*
* @return Whether the currentDocument field is set.
*/
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;
*
* @return The currentDocument.
*/
com.google.firestore.v1.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;
*/
com.google.firestore.v1.PreconditionOrBuilder getCurrentDocumentOrBuilder();
com.google.firestore.v1.Write.OperationCase getOperationCase();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy