com.google.bigtable.v2

Interface PrepareQueryRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PrepareQueryRequest, PrepareQueryRequest.Builder

@Generated
public interface PrepareQueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsParamTypes(String key) Required.
String	getAppProfileId() Optional.
com.google.protobuf.ByteString	getAppProfileIdBytes() Optional.
PrepareQueryRequest.DataFormatCase	getDataFormatCase()
String	getInstanceName() Required.
com.google.protobuf.ByteString	getInstanceNameBytes() Required.
Map<String,Type>	getParamTypes() Deprecated.
int	getParamTypesCount() Required.
Map<String,Type>	getParamTypesMap() Required.
Type	getParamTypesOrDefault(String key, Type defaultValue) Required.
Type	getParamTypesOrThrow(String key) Required.
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.
boolean	hasProtoFormat() Protocol buffer format as described by ProtoSchema and ProtoRows messages.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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 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];

Returns:

The appProfileId.

getAppProfileIdBytes

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];

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;

getParamTypesCount

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];

containsParamTypes

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];

getParamTypes

@Deprecated
Map<String,Type> getParamTypes()

Deprecated.

Use getParamTypesMap() instead.

getParamTypesMap

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];

getParamTypesOrDefault

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];

getParamTypesOrThrow

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];

getDataFormatCase

PrepareQueryRequest.DataFormatCase getDataFormatCase()