com.google.firestore.v1.WriteRequestOrBuilder 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 WriteRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.firestore.v1.WriteRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The database name. In the format:
   * `projects/{project_id}/databases/{database_id}`.
   * This is only required in the first message.
   * 
   *
   * string database = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The database.
   */
  java.lang.String getDatabase();
  /**
   *
   *
   *    * Required. The database name. In the format:
   * `projects/{project_id}/databases/{database_id}`.
   * This is only required in the first message.
   * 
   *
   * string database = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for database.
   */
  com.google.protobuf.ByteString getDatabaseBytes();

  /**
   *
   *
   *    * The ID of the write stream to resume.
   * This may only be set in the first message. When left empty, a new write
   * stream will be created.
   * 
   *
   * string stream_id = 2;
   *
   * @return The streamId.
   */
  java.lang.String getStreamId();
  /**
   *
   *
   *    * The ID of the write stream to resume.
   * This may only be set in the first message. When left empty, a new write
   * stream will be created.
   * 
   *
   * string stream_id = 2;
   *
   * @return The bytes for streamId.
   */
  com.google.protobuf.ByteString getStreamIdBytes();

  /**
   *
   *
   *    * The writes to apply.
   *
   * Always executed atomically and in order.
   * This must be empty on the first request.
   * This may be empty on the last request.
   * This must not be empty on all other requests.
   * 
   *
   * repeated .google.firestore.v1.Write writes = 3;
   */
  java.util.List getWritesList();
  /**
   *
   *
   *    * The writes to apply.
   *
   * Always executed atomically and in order.
   * This must be empty on the first request.
   * This may be empty on the last request.
   * This must not be empty on all other requests.
   * 
   *
   * repeated .google.firestore.v1.Write writes = 3;
   */
  com.google.firestore.v1.Write getWrites(int index);
  /**
   *
   *
   *    * The writes to apply.
   *
   * Always executed atomically and in order.
   * This must be empty on the first request.
   * This may be empty on the last request.
   * This must not be empty on all other requests.
   * 
   *
   * repeated .google.firestore.v1.Write writes = 3;
   */
  int getWritesCount();
  /**
   *
   *
   *    * The writes to apply.
   *
   * Always executed atomically and in order.
   * This must be empty on the first request.
   * This may be empty on the last request.
   * This must not be empty on all other requests.
   * 
   *
   * repeated .google.firestore.v1.Write writes = 3;
   */
  java.util.List getWritesOrBuilderList();
  /**
   *
   *
   *    * The writes to apply.
   *
   * Always executed atomically and in order.
   * This must be empty on the first request.
   * This may be empty on the last request.
   * This must not be empty on all other requests.
   * 
   *
   * repeated .google.firestore.v1.Write writes = 3;
   */
  com.google.firestore.v1.WriteOrBuilder getWritesOrBuilder(int index);

  /**
   *
   *
   *    * A stream token that was previously sent by the server.
   *
   * The client should set this field to the token from the most recent
   * [WriteResponse][google.firestore.v1.WriteResponse] it has received. This
   * acknowledges that the client has received responses up to this token. After
   * sending this token, earlier tokens may not be used anymore.
   *
   * The server may close the stream if there are too many unacknowledged
   * responses.
   *
   * Leave this field unset when creating a new stream. To resume a stream at
   * a specific point, set this field and the `stream_id` field.
   *
   * Leave this field unset when creating a new stream.
   * 
   *
   * bytes stream_token = 4;
   *
   * @return The streamToken.
   */
  com.google.protobuf.ByteString getStreamToken();

  /**
   *
   *
   *    * Labels associated with this write request.
   * 
   *
   * map<string, string> labels = 5;
   */
  int getLabelsCount();
  /**
   *
   *
   *    * Labels associated with this write request.
   * 
   *
   * map<string, string> labels = 5;
   */
  boolean containsLabels(java.lang.String key);
  /** Use {@link #getLabelsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getLabels();
  /**
   *
   *
   *    * Labels associated with this write request.
   * 
   *
   * map<string, string> labels = 5;
   */
  java.util.Map getLabelsMap();
  /**
   *
   *
   *    * Labels associated with this write request.
   * 
   *
   * map<string, string> labels = 5;
   */
  /* nullable */
  java.lang.String getLabelsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * Labels associated with this write request.
   * 
   *
   * map<string, string> labels = 5;
   */
  java.lang.String getLabelsOrThrow(java.lang.String key);
}