ExecuteSqlRequest (Google Cloud Spanner Parent 6.25.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.spanner.v1.ExecuteSqlRequest

All Implemented Interfaces:: Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, ExecuteSqlRequestOrBuilder, Serializable

public final class ExecuteSqlRequest
extends GeneratedMessageV3
implements ExecuteSqlRequestOrBuilder

 The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
 [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].

Protobuf type google.spanner.v1.ExecuteSqlRequest

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExecuteSqlRequest.Builder` The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].
`static class`	`ExecuteSqlRequest.QueryMode` Mode in which the statement must be processed.
`static class`	`ExecuteSqlRequest.QueryOptions` Query optimizer configuration.
`static interface`	`ExecuteSqlRequest.QueryOptionsOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PARAM_TYPES_FIELD_NUMBER`
`static int`	`PARAMS_FIELD_NUMBER`
`static int`	`PARTITION_TOKEN_FIELD_NUMBER`
`static int`	`QUERY_MODE_FIELD_NUMBER`
`static int`	`QUERY_OPTIONS_FIELD_NUMBER`
`static int`	`REQUEST_OPTIONS_FIELD_NUMBER`
`static int`	`RESUME_TOKEN_FIELD_NUMBER`
`static int`	`SEQNO_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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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 ExecuteSqlRequest`	`getDefaultInstance()`
`ExecuteSqlRequest`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Struct`	`getParams()` Parameter names and values that bind to placeholders in the SQL string.
`StructOrBuilder`	`getParamsOrBuilder()` Parameter names and values that bind to placeholders in the SQL string.
`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.
`Parser<ExecuteSqlRequest>`	`getParserForType()`
`ByteString`	`getPartitionToken()` If present, results will be restricted to the specified partition previously created using PartitionQuery().
`ExecuteSqlRequest.QueryMode`	`getQueryMode()` Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats].
`int`	`getQueryModeValue()` Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats].
`ExecuteSqlRequest.QueryOptions`	`getQueryOptions()` Query optimizer configuration to use for the given query.
`ExecuteSqlRequest.QueryOptionsOrBuilder`	`getQueryOptionsOrBuilder()` Query optimizer configuration to use for the given query.
`RequestOptions`	`getRequestOptions()` Common options for this request.
`RequestOptionsOrBuilder`	`getRequestOptionsOrBuilder()` Common options for this request.
`ByteString`	`getResumeToken()` If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption.
`long`	`getSeqno()` A per-transaction sequence number used to identify this request.
`int`	`getSerializedSize()`
`String`	`getSession()` Required.
`ByteString`	`getSessionBytes()` Required.
`String`	`getSql()` Required.
`ByteString`	`getSqlBytes()` Required.
`TransactionSelector`	`getTransaction()` The transaction to use.
`TransactionSelectorOrBuilder`	`getTransactionOrBuilder()` The transaction to use.
`UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`boolean`	`hasParams()` Parameter names and values that bind to placeholders in the SQL string.
`boolean`	`hasQueryOptions()` Query optimizer configuration to use for the given query.
`boolean`	`hasRequestOptions()` Common options for this request.
`boolean`	`hasTransaction()` The transaction to use.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static ExecuteSqlRequest.Builder`	`newBuilder()`
`static ExecuteSqlRequest.Builder`	`newBuilder(ExecuteSqlRequest prototype)`
`ExecuteSqlRequest.Builder`	`newBuilderForType()`
`protected ExecuteSqlRequest.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`
`static ExecuteSqlRequest`	`parseDelimitedFrom(InputStream input)`
`static ExecuteSqlRequest`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static ExecuteSqlRequest`	`parseFrom(byte[] data)`
`static ExecuteSqlRequest`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static ExecuteSqlRequest`	`parseFrom(ByteBuffer data)`
`static ExecuteSqlRequest`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static ExecuteSqlRequest`	`parseFrom(ByteString data)`
`static ExecuteSqlRequest`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static ExecuteSqlRequest`	`parseFrom(CodedInputStream input)`
`static ExecuteSqlRequest`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static ExecuteSqlRequest`	`parseFrom(InputStream input)`
`static ExecuteSqlRequest`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<ExecuteSqlRequest>`	`parser()`
`ExecuteSqlRequest.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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
- RESUME_TOKEN_FIELD_NUMBER
```
public static final int RESUME_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_MODE_FIELD_NUMBER
```
public static final int QUERY_MODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARTITION_TOKEN_FIELD_NUMBER
```
public static final int PARTITION_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SEQNO_FIELD_NUMBER
```
public static final int SEQNO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_OPTIONS_FIELD_NUMBER
```
public static final int QUERY_OPTIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REQUEST_OPTIONS_FIELD_NUMBER
```
public static final int REQUEST_OPTIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class GeneratedMessageV3

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getSession
```
public String getSession()
```
```
 Required. The session in which the SQL query should be performed.
 
```
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getSession in interface ExecuteSqlRequestOrBuilder

Returns:

The session.

getSessionBytes
```
public ByteString getSessionBytes()
```
```
 Required. The session in which the SQL query should be performed.
 
```
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getSessionBytes in interface ExecuteSqlRequestOrBuilder

Returns:

The bytes for session.

hasTransaction

public boolean hasTransaction()

 The transaction to use.
 For queries, if none is provided, the default is a temporary read-only
 transaction with strong concurrency.
 Standard DML statements require a read-write transaction. To protect
 against replays, single-use transactions are not supported.  The caller
 must either supply an existing transaction ID or begin a new transaction.
 Partitioned DML requires an existing Partitioned DML transaction ID.

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

Specified by:: hasTransaction in interface ExecuteSqlRequestOrBuilder
Returns:: Whether the transaction field is set.

getTransaction

public TransactionSelector getTransaction()

 The transaction to use.
 For queries, if none is provided, the default is a temporary read-only
 transaction with strong concurrency.
 Standard DML statements require a read-write transaction. To protect
 against replays, single-use transactions are not supported.  The caller
 must either supply an existing transaction ID or begin a new transaction.
 Partitioned DML requires an existing Partitioned DML transaction ID.

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

Specified by:: getTransaction in interface ExecuteSqlRequestOrBuilder
Returns:: The transaction.

getTransactionOrBuilder

public TransactionSelectorOrBuilder getTransactionOrBuilder()

 The transaction to use.
 For queries, if none is provided, the default is a temporary read-only
 transaction with strong concurrency.
 Standard DML statements require a read-write transaction. To protect
 against replays, single-use transactions are not supported.  The caller
 must either supply an existing transaction ID or begin a new transaction.
 Partitioned DML requires an existing Partitioned DML transaction ID.

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

Specified by:: getTransactionOrBuilder in interface ExecuteSqlRequestOrBuilder

getSql
```
public String getSql()
```
```
 Required. The SQL string.
 
```
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getSql in interface ExecuteSqlRequestOrBuilder

Returns:

The sql.

getSqlBytes
```
public ByteString getSqlBytes()
```
```
 Required. The SQL string.
 
```
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getSqlBytes in interface ExecuteSqlRequestOrBuilder

Returns:

The bytes for sql.

hasParams

public boolean hasParams()

 Parameter names and values that bind to placeholders in the SQL string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names must conform
 to the naming requirements of identifiers as specified at
 https://cloud.google.com/spanner/docs/lexical#identifiers.
 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 a SQL statement with unbound parameters.

.google.protobuf.Struct params = 4;

Specified by:: hasParams in interface ExecuteSqlRequestOrBuilder
Returns:: Whether the params field is set.

getParams

public Struct getParams()

 Parameter names and values that bind to placeholders in the SQL string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names must conform
 to the naming requirements of identifiers as specified at
 https://cloud.google.com/spanner/docs/lexical#identifiers.
 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 a SQL statement with unbound parameters.

.google.protobuf.Struct params = 4;

Specified by:: getParams in interface ExecuteSqlRequestOrBuilder
Returns:: The params.

getParamsOrBuilder

public StructOrBuilder getParamsOrBuilder()

 Parameter names and values that bind to placeholders in the SQL string.
 A parameter placeholder consists of the `@` character followed by the
 parameter name (for example, `@firstName`). Parameter names must conform
 to the naming requirements of identifiers as specified at
 https://cloud.google.com/spanner/docs/lexical#identifiers.
 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 a SQL statement with unbound parameters.

.google.protobuf.Struct params = 4;

Specified by:: getParamsOrBuilder in interface ExecuteSqlRequestOrBuilder