Package com.google.bigtable.v2

Class ExecuteQueryRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.bigtable.v2.ExecuteQueryRequest
All Implemented Interfaces:
ExecuteQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ExecuteQueryRequest extends com.google.protobuf.GeneratedMessageV3 implements ExecuteQueryRequestOrBuilder
 Request message for Bigtable.ExecuteQuery
Protobuf type google.bigtable.v2.ExecuteQueryRequest
See Also:

  • Field Details

    • INSTANCE_NAME_FIELD_NUMBER

      public static final int INSTANCE_NAME_FIELD_NUMBER
      See Also:

    • APP_PROFILE_ID_FIELD_NUMBER

      public static final int APP_PROFILE_ID_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • PREPARED_QUERY_FIELD_NUMBER

      public static final int PREPARED_QUERY_FIELD_NUMBER
      See Also:

    • PROTO_FORMAT_FIELD_NUMBER

      public static final int PROTO_FORMAT_FIELD_NUMBER
      See Also:

    • RESUME_TOKEN_FIELD_NUMBER

      public static final int RESUME_TOKEN_FIELD_NUMBER
      See Also:

    • PARAMS_FIELD_NUMBER

      public static final int PARAMS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getDataFormatCase

      public ExecuteQueryRequest.DataFormatCase getDataFormatCase()
      Specified by:
      getDataFormatCase in interface ExecuteQueryRequestOrBuilder

    • getInstanceName

      public 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) = { ... }
      Specified by:
      getInstanceName in interface ExecuteQueryRequestOrBuilder
      Returns:
      The instanceName.

    • getInstanceNameBytes

      public 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) = { ... }
      Specified by:
      getInstanceNameBytes in interface ExecuteQueryRequestOrBuilder
      Returns:
      The bytes for instanceName.

    • getAppProfileId

      public 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];
      Specified by:
      getAppProfileId in interface ExecuteQueryRequestOrBuilder
      Returns:
      The appProfileId.

    • getAppProfileIdBytes

      public 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];
      Specified by:
      getAppProfileIdBytes in interface ExecuteQueryRequestOrBuilder
      Returns:
      The bytes for appProfileId.

    • getQuery

      @Deprecated public String getQuery()
      Deprecated.
      google.bigtable.v2.ExecuteQueryRequest.query is deprecated. See google/bigtable/v2/bigtable.proto;l=1086
       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];
      Specified by:
      getQuery in interface ExecuteQueryRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      @Deprecated public com.google.protobuf.ByteString getQueryBytes()
      Deprecated.
      google.bigtable.v2.ExecuteQueryRequest.query is deprecated. See google/bigtable/v2/bigtable.proto;l=1086
       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];
      Specified by:
      getQueryBytes in interface ExecuteQueryRequestOrBuilder
      Returns:
      The bytes for query.

    • getPreparedQuery

      public com.google.protobuf.ByteString getPreparedQuery()
       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;
      Specified by:
      getPreparedQuery in interface ExecuteQueryRequestOrBuilder
      Returns:
      The preparedQuery.

    • hasProtoFormat

      @Deprecated public boolean hasProtoFormat()
      Deprecated.
      google.bigtable.v2.ExecuteQueryRequest.proto_format is deprecated. See google/bigtable/v2/bigtable.proto;l=1107
       Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
      .google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];
      Specified by:
      hasProtoFormat in interface ExecuteQueryRequestOrBuilder
      Returns:
      Whether the protoFormat field is set.

    • getProtoFormat

      @Deprecated public ProtoFormat getProtoFormat()
      Deprecated.
      google.bigtable.v2.ExecuteQueryRequest.proto_format is deprecated. See google/bigtable/v2/bigtable.proto;l=1107
       Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
      .google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];
      Specified by:
      getProtoFormat in interface ExecuteQueryRequestOrBuilder
      Returns:
      The protoFormat.

    • getProtoFormatOrBuilder

      @Deprecated public ProtoFormatOrBuilder getProtoFormatOrBuilder()
      Deprecated.
       Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
      .google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];
      Specified by:
      getProtoFormatOrBuilder in interface ExecuteQueryRequestOrBuilder

    • getResumeToken

      public 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];
      Specified by:
      getResumeToken in interface ExecuteQueryRequestOrBuilder
      Returns:
      The resumeToken.

    • getParamsCount

      public int getParamsCount()
      Description copied from interface: ExecuteQueryRequestOrBuilder
       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];
      Specified by:
      getParamsCount in interface ExecuteQueryRequestOrBuilder

    • containsParams

      public 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.

 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];
      Specified by:
      containsParams in interface ExecuteQueryRequestOrBuilder

    • getParams

      @Deprecated public Map<String,Value> getParams()
      Deprecated.
      Use getParamsMap() instead.
      Specified by:
      getParams in interface ExecuteQueryRequestOrBuilder

    • getParamsMap

      public 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.

 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];
      Specified by:
      getParamsMap in interface ExecuteQueryRequestOrBuilder

    • getParamsOrDefault

      public 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.

 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];
      Specified by:
      getParamsOrDefault in interface ExecuteQueryRequestOrBuilder

    • getParamsOrThrow

      public 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.

 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];
      Specified by:
      getParamsOrThrow in interface ExecuteQueryRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExecuteQueryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteQueryRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteQueryRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteQueryRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteQueryRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteQueryRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteQueryRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExecuteQueryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExecuteQueryRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExecuteQueryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExecuteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExecuteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ExecuteQueryRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ExecuteQueryRequest.Builder newBuilder()

    • newBuilder

      public static ExecuteQueryRequest.Builder newBuilder(ExecuteQueryRequest prototype)

    • toBuilder

      public ExecuteQueryRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExecuteQueryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ExecuteQueryRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExecuteQueryRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ExecuteQueryRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ExecuteQueryRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder