com.google.bigtable.v2.ExecuteQueryRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-bigtable-v2 Show documentation
PROTO library for proto-google-cloud-bigtable-v2
The newest version!
/*
 * Copyright 2025 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/bigtable/v2/bigtable.proto

// Protobuf Java Version: 3.25.8
package com.google.bigtable.v2;

public interface ExecuteQueryRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.bigtable.v2.ExecuteQueryRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The unique name of the instance against which the query should be
   * executed.
   * Values are of the form `projects/<project>/instances/<instance>`
   * 
   *
   * 
   * string instance_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The instanceName.
   */
  java.lang.String getInstanceName();

  /**
   *
   *
   *    * Required. The unique name of the instance against which the query should be
   * executed.
   * Values are of the form `projects/<project>/instances/<instance>`
   * 
   *
   * 
   * string instance_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for instanceName.
   */
  com.google.protobuf.ByteString getInstanceNameBytes();

  /**
   *
   *
   *    * Optional. This value specifies routing for replication. If not specified,
   * the `default` application profile will be used.
   * 
   *
   * string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The appProfileId.
   */
  java.lang.String getAppProfileId();

  /**
   *
   *
   *    * Optional. This value specifies routing for replication. If not specified,
   * the `default` application profile will be used.
   * 
   *
   * string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for appProfileId.
   */
  com.google.protobuf.ByteString getAppProfileIdBytes();

  /**
   *
   *
   *    * Required. The query string.
   *
   * Exactly one of `query` and `prepared_query` is required. Setting both
   * or neither is an `INVALID_ARGUMENT`.
   * 
   *
   * string query = 3 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
   *
   * @deprecated google.bigtable.v2.ExecuteQueryRequest.query is deprecated. See
   *     google/bigtable/v2/bigtable.proto;l=1090
   * @return The query.
   */
  @java.lang.Deprecated
  java.lang.String getQuery();

  /**
   *
   *
   *    * Required. The query string.
   *
   * Exactly one of `query` and `prepared_query` is required. Setting both
   * or neither is an `INVALID_ARGUMENT`.
   * 
   *
   * string query = 3 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
   *
   * @deprecated google.bigtable.v2.ExecuteQueryRequest.query is deprecated. See
   *     google/bigtable/v2/bigtable.proto;l=1090
   * @return The bytes for query.
   */
  @java.lang.Deprecated
  com.google.protobuf.ByteString getQueryBytes();

  /**
   *
   *
   *    * A prepared query that was returned from `PrepareQueryResponse`.
   *
   * Exactly one of `query` and `prepared_query` is required. Setting both
   * or neither is an `INVALID_ARGUMENT`.
   *
   * Setting this field also places restrictions on several other fields:
   * - `data_format` must be empty.
   * - `validate_only` must be false.
   * - `params` must match the `param_types` set in the `PrepareQueryRequest`.
   * 
   *
   * bytes prepared_query = 9;
   *
   * @return The preparedQuery.
   */
  com.google.protobuf.ByteString getPreparedQuery();

  /**
   *
   *
   *    * Protocol buffer format as described by ProtoSchema and ProtoRows
   * messages.
   * 
   *
   * .google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];
   *
   * @deprecated google.bigtable.v2.ExecuteQueryRequest.proto_format is deprecated. See
   *     google/bigtable/v2/bigtable.proto;l=1111
   * @return Whether the protoFormat field is set.
   */
  @java.lang.Deprecated
  boolean hasProtoFormat();

  /**
   *
   *
   *    * Protocol buffer format as described by ProtoSchema and ProtoRows
   * messages.
   * 
   *
   * .google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];
   *
   * @deprecated google.bigtable.v2.ExecuteQueryRequest.proto_format is deprecated. See
   *     google/bigtable/v2/bigtable.proto;l=1111
   * @return The protoFormat.
   */
  @java.lang.Deprecated
  com.google.bigtable.v2.ProtoFormat getProtoFormat();

  /**
   *
   *
   *    * Protocol buffer format as described by ProtoSchema and ProtoRows
   * messages.
   * 
   *
   * .google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];
   */
  @java.lang.Deprecated
  com.google.bigtable.v2.ProtoFormatOrBuilder getProtoFormatOrBuilder();

  /**
   *
   *
   *    * Optional. If this request is resuming a previously interrupted query
   * execution, `resume_token` should be copied from the last
   * PartialResultSet yielded before the interruption. Doing this
   * enables the query execution to resume where the last one left
   * off.
   * The rest of the request parameters must exactly match the
   * request that yielded this token. Otherwise the request will fail.
   * 
   *
   * bytes resume_token = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The resumeToken.
   */
  com.google.protobuf.ByteString getResumeToken();

  /**
   *
   *
   *    * Required. params contains string type keys and Bigtable type values that
   * bind to placeholders in the query string. In query string, a parameter
   * placeholder consists of the
   * `@` character followed by the parameter name (for example, `@firstName`) in
   * the query string.
   *
   * For example, if
   * `params["firstName"] = bytes_value: "foo" type {bytes_type {}}`
   * then `@firstName` will be replaced with googlesql bytes value "foo" in the
   * query string during query evaluation.
   *
   * If `Value.kind` is not set, the value is treated as a NULL value of the
   * given type. For example, if
   * `params["firstName"] = type {string_type {}}`
   * then `@firstName` will be replaced with googlesql null string.
   *
   * If `query` is set, any empty `Value.type` in the map will be rejected with
   * `INVALID_ARGUMENT`.
   *
   * If `prepared_query` is set, any empty `Value.type` in the map will be
   * inferred from the `param_types` in the `PrepareQueryRequest`. Any non-empty
   * `Value.type` must match the corresponding `param_types` entry, or be
   * rejected with `INVALID_ARGUMENT`.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  int getParamsCount();

  /**
   *
   *
   *    * Required. params contains string type keys and Bigtable type values that
   * bind to placeholders in the query string. In query string, a parameter
   * placeholder consists of the
   * `@` character followed by the parameter name (for example, `@firstName`) in
   * the query string.
   *
   * For example, if
   * `params["firstName"] = bytes_value: "foo" type {bytes_type {}}`
   * then `@firstName` will be replaced with googlesql bytes value "foo" in the
   * query string during query evaluation.
   *
   * If `Value.kind` is not set, the value is treated as a NULL value of the
   * given type. For example, if
   * `params["firstName"] = type {string_type {}}`
   * then `@firstName` will be replaced with googlesql null string.
   *
   * If `query` is set, any empty `Value.type` in the map will be rejected with
   * `INVALID_ARGUMENT`.
   *
   * If `prepared_query` is set, any empty `Value.type` in the map will be
   * inferred from the `param_types` in the `PrepareQueryRequest`. Any non-empty
   * `Value.type` must match the corresponding `param_types` entry, or be
   * rejected with `INVALID_ARGUMENT`.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  boolean containsParams(java.lang.String key);

  /** Use {@link #getParamsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getParams();

  /**
   *
   *
   *    * Required. params contains string type keys and Bigtable type values that
   * bind to placeholders in the query string. In query string, a parameter
   * placeholder consists of the
   * `@` character followed by the parameter name (for example, `@firstName`) in
   * the query string.
   *
   * For example, if
   * `params["firstName"] = bytes_value: "foo" type {bytes_type {}}`
   * then `@firstName` will be replaced with googlesql bytes value "foo" in the
   * query string during query evaluation.
   *
   * If `Value.kind` is not set, the value is treated as a NULL value of the
   * given type. For example, if
   * `params["firstName"] = type {string_type {}}`
   * then `@firstName` will be replaced with googlesql null string.
   *
   * If `query` is set, any empty `Value.type` in the map will be rejected with
   * `INVALID_ARGUMENT`.
   *
   * If `prepared_query` is set, any empty `Value.type` in the map will be
   * inferred from the `param_types` in the `PrepareQueryRequest`. Any non-empty
   * `Value.type` must match the corresponding `param_types` entry, or be
   * rejected with `INVALID_ARGUMENT`.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  java.util.Map getParamsMap();

  /**
   *
   *
   *    * Required. params contains string type keys and Bigtable type values that
   * bind to placeholders in the query string. In query string, a parameter
   * placeholder consists of the
   * `@` character followed by the parameter name (for example, `@firstName`) in
   * the query string.
   *
   * For example, if
   * `params["firstName"] = bytes_value: "foo" type {bytes_type {}}`
   * then `@firstName` will be replaced with googlesql bytes value "foo" in the
   * query string during query evaluation.
   *
   * If `Value.kind` is not set, the value is treated as a NULL value of the
   * given type. For example, if
   * `params["firstName"] = type {string_type {}}`
   * then `@firstName` will be replaced with googlesql null string.
   *
   * If `query` is set, any empty `Value.type` in the map will be rejected with
   * `INVALID_ARGUMENT`.
   *
   * If `prepared_query` is set, any empty `Value.type` in the map will be
   * inferred from the `param_types` in the `PrepareQueryRequest`. Any non-empty
   * `Value.type` must match the corresponding `param_types` entry, or be
   * rejected with `INVALID_ARGUMENT`.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  /* nullable */
  com.google.bigtable.v2.Value getParamsOrDefault(
      java.lang.String key,
      /* nullable */
      com.google.bigtable.v2.Value defaultValue);

  /**
   *
   *
   *    * Required. params contains string type keys and Bigtable type values that
   * bind to placeholders in the query string. In query string, a parameter
   * placeholder consists of the
   * `@` character followed by the parameter name (for example, `@firstName`) in
   * the query string.
   *
   * For example, if
   * `params["firstName"] = bytes_value: "foo" type {bytes_type {}}`
   * then `@firstName` will be replaced with googlesql bytes value "foo" in the
   * query string during query evaluation.
   *
   * If `Value.kind` is not set, the value is treated as a NULL value of the
   * given type. For example, if
   * `params["firstName"] = type {string_type {}}`
   * then `@firstName` will be replaced with googlesql null string.
   *
   * If `query` is set, any empty `Value.type` in the map will be rejected with
   * `INVALID_ARGUMENT`.
   *
   * If `prepared_query` is set, any empty `Value.type` in the map will be
   * inferred from the `param_types` in the `PrepareQueryRequest`. Any non-empty
   * `Value.type` must match the corresponding `param_types` entry, or be
   * rejected with `INVALID_ARGUMENT`.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.bigtable.v2.Value getParamsOrThrow(java.lang.String key);

  com.google.bigtable.v2.ExecuteQueryRequest.DataFormatCase getDataFormatCase();
}