com.google.spanner.v1

Class PartitionQueryRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.v1.PartitionQueryRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PartitionQueryRequestOrBuilder, Serializable

public final class PartitionQueryRequest
extends com.google.protobuf.GeneratedMessageV3
implements PartitionQueryRequestOrBuilder

 The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]
 

Protobuf type google.spanner.v1.PartitionQueryRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PartitionQueryRequest.Builder The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	PARAM_TYPES_FIELD_NUMBER
static int	PARAMS_FIELD_NUMBER
static int	PARTITION_OPTIONS_FIELD_NUMBER
static int	SESSION_FIELD_NUMBER
static int	SQL_FIELD_NUMBER
static int	TRANSACTION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
boolean	equals(Object obj)
static PartitionQueryRequest	getDefaultInstance()
PartitionQueryRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Struct	getParams() The SQL query string can contain parameter placeholders.
com.google.protobuf.StructOrBuilder	getParamsOrBuilder() The SQL query string can contain parameter placeholders.
Map<String,Type>	getParamTypes() Deprecated.
int	getParamTypesCount() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Map<String,Type>	getParamTypesMap() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Type	getParamTypesOrDefault(String key, Type defaultValue) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Type	getParamTypesOrThrow(String key) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
com.google.protobuf.Parser<PartitionQueryRequest>	getParserForType()
PartitionOptions	getPartitionOptions() Additional options that affect how many partitions are created.
PartitionOptionsOrBuilder	getPartitionOptionsOrBuilder() Additional options that affect how many partitions are created.
int	getSerializedSize()
String	getSession() Required.
com.google.protobuf.ByteString	getSessionBytes() Required.
String	getSql() The query request to generate partitions for.
com.google.protobuf.ByteString	getSqlBytes() The query request to generate partitions for.
TransactionSelector	getTransaction() Read only snapshot transactions are supported, read/write and single use transactions are not.
TransactionSelectorOrBuilder	getTransactionOrBuilder() Read only snapshot transactions are supported, read/write and single use transactions are not.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasParams() The SQL query string can contain parameter placeholders.
boolean	hasPartitionOptions() Additional options that affect how many partitions are created.
boolean	hasTransaction() Read only snapshot transactions are supported, read/write and single use transactions are not.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static PartitionQueryRequest.Builder	newBuilder()
static PartitionQueryRequest.Builder	newBuilder(PartitionQueryRequest prototype)
PartitionQueryRequest.Builder	newBuilderForType()
protected PartitionQueryRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static PartitionQueryRequest	parseDelimitedFrom(InputStream input)
static PartitionQueryRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(byte[] data)
static PartitionQueryRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(ByteBuffer data)
static PartitionQueryRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(com.google.protobuf.ByteString data)
static PartitionQueryRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static PartitionQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PartitionQueryRequest	parseFrom(InputStream input)
static PartitionQueryRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PartitionQueryRequest>	parser()
PartitionQueryRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER

See Also:

Constant Field Values

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER

See Also:

Constant Field Values

SQL_FIELD_NUMBER

public static final int SQL_FIELD_NUMBER

See Also:

Constant Field Values

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

PARAM_TYPES_FIELD_NUMBER

public static final int PARAM_TYPES_FIELD_NUMBER

See Also:

Constant Field Values

PARTITION_OPTIONS_FIELD_NUMBER

public static final int PARTITION_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSession

public String getSession()

 Required. The session used to create the partitions.
 

string session = 1;

Specified by:

getSession in interface PartitionQueryRequestOrBuilder

getSessionBytes

public com.google.protobuf.ByteString getSessionBytes()

 Required. The session used to create the partitions.
 

string session = 1;

Specified by:

getSessionBytes in interface PartitionQueryRequestOrBuilder

hasTransaction

public boolean hasTransaction()

 Read only snapshot transactions are supported, read/write and single use
 transactions are not.
 

.google.spanner.v1.TransactionSelector transaction = 2;

Specified by:

hasTransaction in interface PartitionQueryRequestOrBuilder

getTransaction

public TransactionSelector getTransaction()

 Read only snapshot transactions are supported, read/write and single use
 transactions are not.
 

.google.spanner.v1.TransactionSelector transaction = 2;

Specified by:

getTransaction in interface PartitionQueryRequestOrBuilder

getTransactionOrBuilder

public TransactionSelectorOrBuilder getTransactionOrBuilder()

 Read only snapshot transactions are supported, read/write and single use
 transactions are not.
 

.google.spanner.v1.TransactionSelector transaction = 2;

Specified by:

getTransactionOrBuilder in interface PartitionQueryRequestOrBuilder

getSql

public String getSql()

 The query request to generate partitions for. The request will fail if
 the query is not root partitionable. The query plan of a root
 partitionable query has a single distributed union operator. A distributed
 union operator conceptually divides one or more tables into multiple
 splits, remotely evaluates a subquery independently on each split, and
 then unions all results.
 This must not contain DML commands, such as INSERT, UPDATE, or
 DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
 PartitionedDml transaction for large, partition-friendly DML operations.
 

string sql = 3;

Specified by:

getSql in interface PartitionQueryRequestOrBuilder

getSqlBytes

public com.google.protobuf.ByteString getSqlBytes()

 The query request to generate partitions for. The request will fail if
 the query is not root partitionable. The query plan of a root
 partitionable query has a single distributed union operator. A distributed
 union operator conceptually divides one or more tables into multiple
 splits, remotely evaluates a subquery independently on each split, and
 then unions all results.
 This must not contain DML commands, such as INSERT, UPDATE, or
 DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
 PartitionedDml transaction for large, partition-friendly DML operations.
 

string sql = 3;

Specified by:

getSqlBytes in interface PartitionQueryRequestOrBuilder

hasParams

public boolean hasParams()

 The SQL query string can contain parameter placeholders. A parameter
 placeholder consists of `'@'` followed by the parameter
 name. Parameter names consist of any combination of letters,
 numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:
   `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute an SQL query with unbound parameters.
 Parameter values are specified using `params`, which is a JSON
 object whose keys are parameter names, and whose values are the
 corresponding parameter values.
 

.google.protobuf.Struct params = 4;

Specified by:

hasParams in interface PartitionQueryRequestOrBuilder

getParams

public com.google.protobuf.Struct getParams()

 The SQL query string can contain parameter placeholders. A parameter
 placeholder consists of `'@'` followed by the parameter
 name. Parameter names consist of any combination of letters,
 numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:
   `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute an SQL query with unbound parameters.
 Parameter values are specified using `params`, which is a JSON
 object whose keys are parameter names, and whose values are the
 corresponding parameter values.
 

.google.protobuf.Struct params = 4;

Specified by:

getParams in interface PartitionQueryRequestOrBuilder

getParamsOrBuilder

public com.google.protobuf.StructOrBuilder getParamsOrBuilder()

 The SQL query string can contain parameter placeholders. A parameter
 placeholder consists of `'@'` followed by the parameter
 name. Parameter names consist of any combination of letters,
 numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:
   `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute an SQL query with unbound parameters.
 Parameter values are specified using `params`, which is a JSON
 object whose keys are parameter names, and whose values are the
 corresponding parameter values.
 

.google.protobuf.Struct params = 4;

Specified by:

getParamsOrBuilder in interface PartitionQueryRequestOrBuilder

getParamTypesCount

public int getParamTypesCount()

Description copied from interface: PartitionQueryRequestOrBuilder

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

getParamTypesCount in interface PartitionQueryRequestOrBuilder

containsParamTypes

public boolean containsParamTypes(String key)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

containsParamTypes in interface PartitionQueryRequestOrBuilder

getParamTypes

@Deprecated
public Map<String,Type> getParamTypes()

Deprecated.

Use getParamTypesMap() instead.

Specified by:

getParamTypes in interface PartitionQueryRequestOrBuilder

getParamTypesMap

public Map<String,Type> getParamTypesMap()

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

getParamTypesMap in interface PartitionQueryRequestOrBuilder

getParamTypesOrDefault

public Type getParamTypesOrDefault(String key,
                                   Type defaultValue)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

getParamTypesOrDefault in interface PartitionQueryRequestOrBuilder

getParamTypesOrThrow

public Type getParamTypesOrThrow(String key)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

getParamTypesOrThrow in interface PartitionQueryRequestOrBuilder

hasPartitionOptions

public boolean hasPartitionOptions()

 Additional options that affect how many partitions are created.
 

.google.spanner.v1.PartitionOptions partition_options = 6;

Specified by:

hasPartitionOptions in interface PartitionQueryRequestOrBuilder

getPartitionOptions

public PartitionOptions getPartitionOptions()

 Additional options that affect how many partitions are created.
 

.google.spanner.v1.PartitionOptions partition_options = 6;

Specified by:

getPartitionOptions in interface PartitionQueryRequestOrBuilder

getPartitionOptionsOrBuilder

public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()

 Additional options that affect how many partitions are created.
 

.google.spanner.v1.PartitionOptions partition_options = 6;

Specified by:

getPartitionOptionsOrBuilder in interface PartitionQueryRequestOrBuilder

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 PartitionQueryRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PartitionQueryRequest parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PartitionQueryRequest parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PartitionQueryRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static PartitionQueryRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static PartitionQueryRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public PartitionQueryRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PartitionQueryRequest.Builder newBuilder()

newBuilder

public static PartitionQueryRequest.Builder newBuilder(PartitionQueryRequest prototype)

toBuilder

public PartitionQueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PartitionQueryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PartitionQueryRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<PartitionQueryRequest> 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 PartitionQueryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder