com.google.bigtable.v2

Class PrepareQueryRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

@Generated
public final class PrepareQueryRequest
extends com.google.protobuf.GeneratedMessage
implements PrepareQueryRequestOrBuilder

 Request message for Bigtable.PrepareQuery
 

Protobuf type google.bigtable.v2.PrepareQueryRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrepareQueryRequest.Builder Request message for Bigtable.PrepareQuery Protobuf type google.bigtable.v2.PrepareQueryRequest
static class	PrepareQueryRequest.DataFormatCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	APP_PROFILE_ID_FIELD_NUMBER
static int	INSTANCE_NAME_FIELD_NUMBER
static int	PARAM_TYPES_FIELD_NUMBER
static int	PROTO_FORMAT_FIELD_NUMBER
static int	QUERY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsParamTypes(String key) Required.
boolean	equals(Object obj)
String	getAppProfileId() Optional.
com.google.protobuf.ByteString	getAppProfileIdBytes() Optional.
PrepareQueryRequest.DataFormatCase	getDataFormatCase()
static PrepareQueryRequest	getDefaultInstance()
PrepareQueryRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<PrepareQueryRequest>	getParserForType()
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.
int	getSerializedSize()
int	hashCode()
boolean	hasProtoFormat() Protocol buffer format as described by ProtoSchema and ProtoRows messages.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static PrepareQueryRequest.Builder	newBuilder()
static PrepareQueryRequest.Builder	newBuilder(PrepareQueryRequest prototype)
PrepareQueryRequest.Builder	newBuilderForType()
protected PrepareQueryRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static PrepareQueryRequest	parseDelimitedFrom(InputStream input)
static PrepareQueryRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrepareQueryRequest	parseFrom(byte[] data)
static PrepareQueryRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrepareQueryRequest	parseFrom(ByteBuffer data)
static PrepareQueryRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrepareQueryRequest	parseFrom(com.google.protobuf.ByteString data)
static PrepareQueryRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrepareQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static PrepareQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PrepareQueryRequest	parseFrom(InputStream input)
static PrepareQueryRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PrepareQueryRequest>	parser()
PrepareQueryRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INSTANCE_NAME_FIELD_NUMBER

public static final int INSTANCE_NAME_FIELD_NUMBER

See Also:

Constant Field Values

APP_PROFILE_ID_FIELD_NUMBER

public static final int APP_PROFILE_ID_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

See Also:

Constant Field Values

PROTO_FORMAT_FIELD_NUMBER

public static final int PROTO_FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

PARAM_TYPES_FIELD_NUMBER

public static final int PARAM_TYPES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

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

getDefaultInstanceForType

public PrepareQueryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder