com.google.firestore.v1.CreateDocumentRequestOrBuilder 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
PROTO library for proto-google-cloud-firestore-v1
There is a newer version: 3.29.1
Show newest version
/*
 * 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/firestore.proto

// Protobuf Java Version: 3.25.4
package com.google.firestore.v1;

public interface CreateDocumentRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.firestore.v1.CreateDocumentRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The parent resource. For example:
   * `projects/{project_id}/databases/{database_id}/documents` or
   * `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
   * 
   *
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. The parent resource. For example:
   * `projects/{project_id}/databases/{database_id}/documents` or
   * `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
   * 
   *
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Required. The collection ID, relative to `parent`, to list. For example:
   * `chatrooms`.
   * 
   *
   * string collection_id = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The collectionId.
   */
  java.lang.String getCollectionId();
  /**
   *
   *
   *    * Required. The collection ID, relative to `parent`, to list. For example:
   * `chatrooms`.
   * 
   *
   * string collection_id = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for collectionId.
   */
  com.google.protobuf.ByteString getCollectionIdBytes();

  /**
   *
   *
   *    * The client-assigned document ID to use for this document.
   *
   * Optional. If not specified, an ID will be assigned by the service.
   * 
   *
   * string document_id = 3;
   *
   * @return The documentId.
   */
  java.lang.String getDocumentId();
  /**
   *
   *
   *    * The client-assigned document ID to use for this document.
   *
   * Optional. If not specified, an ID will be assigned by the service.
   * 
   *
   * string document_id = 3;
   *
   * @return The bytes for documentId.
   */
  com.google.protobuf.ByteString getDocumentIdBytes();

  /**
   *
   *
   *    * Required. The document to create. `name` must not be set.
   * 
   *
   * .google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the document field is set.
   */
  boolean hasDocument();
  /**
   *
   *
   *    * Required. The document to create. `name` must not be set.
   * 
   *
   * .google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The document.
   */
  com.google.firestore.v1.Document getDocument();
  /**
   *
   *
   *    * Required. The document to create. `name` must not be set.
   * 
   *
   * .google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.firestore.v1.DocumentOrBuilder getDocumentOrBuilder();

  /**
   *
   *
   *    * 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 = 5;
   *
   * @return Whether the mask field is set.
   */
  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 = 5;
   *
   * @return The mask.
   */
  com.google.firestore.v1.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 = 5;
   */
  com.google.firestore.v1.DocumentMaskOrBuilder getMaskOrBuilder();
}