Package com.google.bigtable.v2

Class PrepareQueryRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.bigtable.v2.PrepareQueryRequest
All Implemented Interfaces:
PrepareQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class PrepareQueryRequest extends com.google.protobuf.GeneratedMessageV3 implements PrepareQueryRequestOrBuilder
 Request message for Bigtable.PrepareQuery
Protobuf type google.bigtable.v2.PrepareQueryRequest
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:

    • PROTO_FORMAT_FIELD_NUMBER

      public static final int PROTO_FORMAT_FIELD_NUMBER
      See Also:

    • PARAM_TYPES_FIELD_NUMBER

      public static final int PARAM_TYPES_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 PrepareQueryRequest.DataFormatCase getDataFormatCase()
      Specified by:
      getDataFormatCase in interface PrepareQueryRequestOrBuilder

    • 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 PrepareQueryRequestOrBuilder
      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 PrepareQueryRequestOrBuilder
      Returns:
      The bytes for instanceName.

    • getAppProfileId

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

    • getAppProfileIdBytes

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

    • getQuery

      public String getQuery()
       Required. The query string.
      string query = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface PrepareQueryRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

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

    • hasProtoFormat

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

    • getProtoFormat

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

    • getProtoFormatOrBuilder

      public ProtoFormatOrBuilder getProtoFormatOrBuilder()
       Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
      .google.bigtable.v2.ProtoFormat proto_format = 4;
      Specified by:
      getProtoFormatOrBuilder in interface PrepareQueryRequestOrBuilder

    • getParamTypesCount

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

    • containsParamTypes

      public boolean containsParamTypes(String key)
       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];
      Specified by:
      containsParamTypes in interface PrepareQueryRequestOrBuilder

    • getParamTypes

      @Deprecated public Map<String,Type> getParamTypes()
      Deprecated.
      Use getParamTypesMap() instead.
      Specified by:
      getParamTypes in interface PrepareQueryRequestOrBuilder

    • getParamTypesMap

      public Map<String,Type> 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];
      Specified by:
      getParamTypesMap in interface PrepareQueryRequestOrBuilder

    • getParamTypesOrDefault

      public Type getParamTypesOrDefault(String key, 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];
      Specified by:
      getParamTypesOrDefault in interface PrepareQueryRequestOrBuilder

    • getParamTypesOrThrow

      public Type getParamTypesOrThrow(String key)
       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];
      Specified by:
      getParamTypesOrThrow in interface PrepareQueryRequestOrBuilder

    • 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 PrepareQueryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PrepareQueryRequest.Builder newBuilder()

    • newBuilder

      public static PrepareQueryRequest.Builder newBuilder(PrepareQueryRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PrepareQueryRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<PrepareQueryRequest> 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 PrepareQueryRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder