Package com.google.bigtable.v2

Interface ExecuteQueryRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExecuteQueryRequest, ExecuteQueryRequest.Builder
public interface ExecuteQueryRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsParams(String key)
    Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
    String
    getAppProfileId()
    Optional.
    com.google.protobuf.ByteString
    getAppProfileIdBytes()
    Optional.
    ExecuteQueryRequest.DataFormatCase
    getDataFormatCase()
     
    String
    getInstanceName()
    Required.
    com.google.protobuf.ByteString
    getInstanceNameBytes()
    Required.
    Map<String,Value>
    getParams()
    Deprecated.
    int
    getParamsCount()
    Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
    Map<String,Value>
    getParamsMap()
    Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
    Value
    getParamsOrDefault(String key, Value defaultValue)
    Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
    Value
    getParamsOrThrow(String key)
    Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
    ProtoFormat
    getProtoFormat()
    Protocol buffer format as described by ProtoSchema and ProtoRows messages.
    ProtoFormatOrBuilder
    getProtoFormatOrBuilder()
    Protocol buffer format as described by ProtoSchema and ProtoRows messages.
    String
    getQuery()
    Required.
    com.google.protobuf.ByteString
    getQueryBytes()
    Required.
    com.google.protobuf.ByteString
    getResumeToken()
    Optional.
    boolean
    hasProtoFormat()
    Protocol buffer format as described by ProtoSchema and ProtoRows messages.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getInstanceName

      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) = { ... }
      Returns:
      The instanceName.

    • getInstanceNameBytes

      com.google.protobuf.ByteString getInstanceNameBytes()
       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) = { ... }
      Returns:
      The bytes for instanceName.

    • getAppProfileId

      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];
      Returns:
      The appProfileId.

    • getAppProfileIdBytes

      com.google.protobuf.ByteString getAppProfileIdBytes()
       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];
      Returns:
      The bytes for appProfileId.

    • getQuery

      String getQuery()
       Required. The query string.
      string query = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The query.

    • getQueryBytes

      com.google.protobuf.ByteString getQueryBytes()
       Required. The query string.
      string query = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for query.

    • hasProtoFormat

      boolean hasProtoFormat()
       Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
      .google.bigtable.v2.ProtoFormat proto_format = 4;
      Returns:
      Whether the protoFormat field is set.

    • getProtoFormat

      ProtoFormat getProtoFormat()
       Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
      .google.bigtable.v2.ProtoFormat proto_format = 4;
      Returns:
      The protoFormat.

    • getProtoFormatOrBuilder

      ProtoFormatOrBuilder getProtoFormatOrBuilder()
       Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
      .google.bigtable.v2.ProtoFormat proto_format = 4;

    • getResumeToken

      com.google.protobuf.ByteString getResumeToken()
       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];
      Returns:
      The resumeToken.

    • getParamsCount

      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.

 In case of Value.kind is not set, it will be set to corresponding null
 value in googlesql.
  `params["firstName"] =  type {string_type {}}`
  then `@firstName` will be replaced with googlesql null string.

 Value.type should always be set and no inference of type will be made from
 Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT
 error.
      map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

    • containsParams

      boolean containsParams(String key)
       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.

 In case of Value.kind is not set, it will be set to corresponding null
 value in googlesql.
  `params["firstName"] =  type {string_type {}}`
  then `@firstName` will be replaced with googlesql null string.

 Value.type should always be set and no inference of type will be made from
 Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT
 error.
      map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

    • getParams

      @Deprecated Map<String,Value> getParams()
      Deprecated.
      Use getParamsMap() instead.

    • getParamsMap

      Map<String,Value> 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.

 In case of Value.kind is not set, it will be set to corresponding null
 value in googlesql.
  `params["firstName"] =  type {string_type {}}`
  then `@firstName` will be replaced with googlesql null string.

 Value.type should always be set and no inference of type will be made from
 Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT
 error.
      map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

    • getParamsOrDefault

      Value getParamsOrDefault(String key, 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.

 In case of Value.kind is not set, it will be set to corresponding null
 value in googlesql.
  `params["firstName"] =  type {string_type {}}`
  then `@firstName` will be replaced with googlesql null string.

 Value.type should always be set and no inference of type will be made from
 Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT
 error.
      map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

    • getParamsOrThrow

      Value getParamsOrThrow(String key)
       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.

 In case of Value.kind is not set, it will be set to corresponding null
 value in googlesql.
  `params["firstName"] =  type {string_type {}}`
  then `@firstName` will be replaced with googlesql null string.

 Value.type should always be set and no inference of type will be made from
 Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT
 error.
      map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

    • getDataFormatCase

      ExecuteQueryRequest.DataFormatCase getDataFormatCase()