com.google.datastore.v1.ReadOptionsOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtime-impl-jetty12 Show documentation
There is a newer version: 2.0.31
/*
 * Copyright 2023 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/datastore/v1/datastore.proto

package com.google.datastore.v1;

public interface ReadOptionsOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.datastore.v1.ReadOptions)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The non-transactional read consistency to use.
   * 
   *
   * .google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
   *
   * @return Whether the readConsistency field is set.
   */
  boolean hasReadConsistency();
  /**
   *
   *
   *    * The non-transactional read consistency to use.
   * 
   *
   * .google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
   *
   * @return The enum numeric value on the wire for readConsistency.
   */
  int getReadConsistencyValue();
  /**
   *
   *
   *    * The non-transactional read consistency to use.
   * 
   *
   * .google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
   *
   * @return The readConsistency.
   */
  com.google.datastore.v1.ReadOptions.ReadConsistency getReadConsistency();

  /**
   *
   *
   *    * The identifier of the transaction in which to read. A
   * transaction identifier is returned by a call to
   * [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
   * 
   *
   * bytes transaction = 2;
   *
   * @return Whether the transaction field is set.
   */
  boolean hasTransaction();
  /**
   *
   *
   *    * The identifier of the transaction in which to read. A
   * transaction identifier is returned by a call to
   * [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
   * 
   *
   * bytes transaction = 2;
   *
   * @return The transaction.
   */
  com.google.protobuf.ByteString getTransaction();

  /**
   *
   *
   *    * Options for beginning a new transaction for this request.
   *
   * The new transaction identifier will be returned in the corresponding
   * response as either
   * [LookupResponse.transaction][google.datastore.v1.LookupResponse.transaction]
   * or
   * [RunQueryResponse.transaction][google.datastore.v1.RunQueryResponse.transaction].
   * 
   *
   * .google.datastore.v1.TransactionOptions new_transaction = 3;
   *
   * @return Whether the newTransaction field is set.
   */
  boolean hasNewTransaction();
  /**
   *
   *
   *    * Options for beginning a new transaction for this request.
   *
   * The new transaction identifier will be returned in the corresponding
   * response as either
   * [LookupResponse.transaction][google.datastore.v1.LookupResponse.transaction]
   * or
   * [RunQueryResponse.transaction][google.datastore.v1.RunQueryResponse.transaction].
   * 
   *
   * .google.datastore.v1.TransactionOptions new_transaction = 3;
   *
   * @return The newTransaction.
   */
  com.google.datastore.v1.TransactionOptions getNewTransaction();
  /**
   *
   *
   *    * Options for beginning a new transaction for this request.
   *
   * The new transaction identifier will be returned in the corresponding
   * response as either
   * [LookupResponse.transaction][google.datastore.v1.LookupResponse.transaction]
   * or
   * [RunQueryResponse.transaction][google.datastore.v1.RunQueryResponse.transaction].
   * 
   *
   * .google.datastore.v1.TransactionOptions new_transaction = 3;
   */
  com.google.datastore.v1.TransactionOptionsOrBuilder getNewTransactionOrBuilder();

  /**
   *
   *
   *    * Reads entities as they were at the given time. This value is only
   * supported for Cloud Firestore in Datastore mode.
   *
   * 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 = 4;
   *
   * @return Whether the readTime field is set.
   */
  boolean hasReadTime();
  /**
   *
   *
   *    * Reads entities as they were at the given time. This value is only
   * supported for Cloud Firestore in Datastore mode.
   *
   * 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 = 4;
   *
   * @return The readTime.
   */
  com.google.protobuf.Timestamp getReadTime();
  /**
   *
   *
   *    * Reads entities as they were at the given time. This value is only
   * supported for Cloud Firestore in Datastore mode.
   *
   * 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 = 4;
   */
  com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder();

  com.google.datastore.v1.ReadOptions.ConsistencyTypeCase getConsistencyTypeCase();
}