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

Go to download
/*
 * 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.5
package com.google.bigtable.v2;

public interface PrepareQueryRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.bigtable.v2.PrepareQueryRequest)
    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 preparing the query. Note that
   * this `app_profile_id` is only used for preparing the query. The actual
   * query execution will use the app profile specified in the
   * `ExecuteQueryRequest`. 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 preparing the query. Note that
   * this `app_profile_id` is only used for preparing the query. The actual
   * query execution will use the app profile specified in the
   * `ExecuteQueryRequest`. 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.
   * 
   *
   * string query = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The query.
   */
  java.lang.String getQuery();
  /**
   *
   *
   *    * Required. The query string.
   * 
   *
   * string query = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for query.
   */
  com.google.protobuf.ByteString getQueryBytes();

  /**
   *
   *
   *    * Protocol buffer format as described by ProtoSchema and ProtoRows
   * messages.
   * 
   *
   * .google.bigtable.v2.ProtoFormat proto_format = 4;
   *
   * @return Whether the protoFormat field is set.
   */
  boolean hasProtoFormat();
  /**
   *
   *
   *    * Protocol buffer format as described by ProtoSchema and ProtoRows
   * messages.
   * 
   *
   * .google.bigtable.v2.ProtoFormat proto_format = 4;
   *
   * @return The protoFormat.
   */
  com.google.bigtable.v2.ProtoFormat getProtoFormat();
  /**
   *
   *
   *    * Protocol buffer format as described by ProtoSchema and ProtoRows
   * messages.
   * 
   *
   * .google.bigtable.v2.ProtoFormat proto_format = 4;
   */
  com.google.bigtable.v2.ProtoFormatOrBuilder getProtoFormatOrBuilder();

  /**
   *
   *
   *    * Required. `param_types` is a map of parameter identifier strings to their
   * `Type`s.
   *
   * 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 param_types["firstName"] = Bytes then @firstName will be a
   * query parameter of type Bytes. The specific `Value` to be used for the
   * query execution must be sent in `ExecuteQueryRequest` in the `params` map.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  int getParamTypesCount();
  /**
   *
   *
   *    * Required. `param_types` is a map of parameter identifier strings to their
   * `Type`s.
   *
   * 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 param_types["firstName"] = Bytes then @firstName will be a
   * query parameter of type Bytes. The specific `Value` to be used for the
   * query execution must be sent in `ExecuteQueryRequest` in the `params` map.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  boolean containsParamTypes(java.lang.String key);
  /** Use {@link #getParamTypesMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getParamTypes();
  /**
   *
   *
   *    * Required. `param_types` is a map of parameter identifier strings to their
   * `Type`s.
   *
   * 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 param_types["firstName"] = Bytes then @firstName will be a
   * query parameter of type Bytes. The specific `Value` to be used for the
   * query execution must be sent in `ExecuteQueryRequest` in the `params` map.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  java.util.Map getParamTypesMap();
  /**
   *
   *
   *    * Required. `param_types` is a map of parameter identifier strings to their
   * `Type`s.
   *
   * 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 param_types["firstName"] = Bytes then @firstName will be a
   * query parameter of type Bytes. The specific `Value` to be used for the
   * query execution must be sent in `ExecuteQueryRequest` in the `params` map.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  /* nullable */
  com.google.bigtable.v2.Type getParamTypesOrDefault(
      java.lang.String key,
      /* nullable */
      com.google.bigtable.v2.Type defaultValue);
  /**
   *
   *
   *    * Required. `param_types` is a map of parameter identifier strings to their
   * `Type`s.
   *
   * 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 param_types["firstName"] = Bytes then @firstName will be a
   * query parameter of type Bytes. The specific `Value` to be used for the
   * query execution must be sent in `ExecuteQueryRequest` in the `params` map.
   * 
   *
   * 
   * map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.bigtable.v2.Type getParamTypesOrThrow(java.lang.String key);

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