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

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

  /**
   *
   *
   *    * A structured query.
   * 
   *
   * .google.firestore.v1.StructuredQuery structured_query = 2;
   *
   * @return Whether the structuredQuery field is set.
   */
  boolean hasStructuredQuery();
  /**
   *
   *
   *    * A structured query.
   * 
   *
   * .google.firestore.v1.StructuredQuery structured_query = 2;
   *
   * @return The structuredQuery.
   */
  com.google.firestore.v1.StructuredQuery getStructuredQuery();
  /**
   *
   *
   *    * A structured query.
   * 
   *
   * .google.firestore.v1.StructuredQuery structured_query = 2;
   */
  com.google.firestore.v1.StructuredQueryOrBuilder getStructuredQueryOrBuilder();

  /**
   *
   *
   *    * Run the query within an already active transaction.
   *
   * The value here is the opaque transaction ID to execute the query in.
   * 
   *
   * bytes transaction = 5;
   *
   * @return Whether the transaction field is set.
   */
  boolean hasTransaction();
  /**
   *
   *
   *    * Run the query within an already active transaction.
   *
   * The value here is the opaque transaction ID to execute the query in.
   * 
   *
   * bytes transaction = 5;
   *
   * @return The transaction.
   */
  com.google.protobuf.ByteString getTransaction();

  /**
   *
   *
   *    * Starts a new transaction and reads the documents.
   * Defaults to a read-only transaction.
   * The new transaction ID will be returned as the first response in the
   * stream.
   * 
   *
   * .google.firestore.v1.TransactionOptions new_transaction = 6;
   *
   * @return Whether the newTransaction field is set.
   */
  boolean hasNewTransaction();
  /**
   *
   *
   *    * Starts a new transaction and reads the documents.
   * Defaults to a read-only transaction.
   * The new transaction ID will be returned as the first response in the
   * stream.
   * 
   *
   * .google.firestore.v1.TransactionOptions new_transaction = 6;
   *
   * @return The newTransaction.
   */
  com.google.firestore.v1.TransactionOptions getNewTransaction();
  /**
   *
   *
   *    * Starts a new transaction and reads the documents.
   * Defaults to a read-only transaction.
   * The new transaction ID will be returned as the first response in the
   * stream.
   * 
   *
   * .google.firestore.v1.TransactionOptions new_transaction = 6;
   */
  com.google.firestore.v1.TransactionOptionsOrBuilder getNewTransactionOrBuilder();

  /**
   *
   *
   *    * Reads documents as they were at the given time.
   *
   * This must be a microsecond precision timestamp within the past one hour,
   * or if Point-in-Time Recovery is enabled, can additionally be a whole
   * minute timestamp within the past 7 days.
   * 
   *
   * .google.protobuf.Timestamp read_time = 7;
   *
   * @return Whether the readTime field is set.
   */
  boolean hasReadTime();
  /**
   *
   *
   *    * Reads documents as they were at the given time.
   *
   * This must be a microsecond precision timestamp within the past one hour,
   * or if Point-in-Time Recovery is enabled, can additionally be a whole
   * minute timestamp within the past 7 days.
   * 
   *
   * .google.protobuf.Timestamp read_time = 7;
   *
   * @return The readTime.
   */
  com.google.protobuf.Timestamp getReadTime();
  /**
   *
   *
   *    * Reads documents as they were at the given time.
   *
   * This must be a microsecond precision timestamp within the past one hour,
   * or if Point-in-Time Recovery is enabled, can additionally be a whole
   * minute timestamp within the past 7 days.
   * 
   *
   * .google.protobuf.Timestamp read_time = 7;
   */
  com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder();

  /**
   *
   *
   *    * Optional. Explain options for the query. If set, additional query
   * statistics will be returned. If not, only query results will be returned.
   * 
   *
   * 
   * .google.firestore.v1.ExplainOptions explain_options = 10 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the explainOptions field is set.
   */
  boolean hasExplainOptions();
  /**
   *
   *
   *    * Optional. Explain options for the query. If set, additional query
   * statistics will be returned. If not, only query results will be returned.
   * 
   *
   * 
   * .google.firestore.v1.ExplainOptions explain_options = 10 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The explainOptions.
   */
  com.google.firestore.v1.ExplainOptions getExplainOptions();
  /**
   *
   *
   *    * Optional. Explain options for the query. If set, additional query
   * statistics will be returned. If not, only query results will be returned.
   * 
   *
   * 
   * .google.firestore.v1.ExplainOptions explain_options = 10 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.firestore.v1.ExplainOptionsOrBuilder getExplainOptionsOrBuilder();

  com.google.firestore.v1.RunQueryRequest.QueryTypeCase getQueryTypeCase();

  com.google.firestore.v1.RunQueryRequest.ConsistencySelectorCase getConsistencySelectorCase();
}