Class BeginTransactionRequest (6.86.0) 

public final class BeginTransactionRequest extends GeneratedMessageV3 implements BeginTransactionRequestOrBuilder

The request for BeginTransaction.

Protobuf type google.spanner.v1.BeginTransactionRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BeginTransactionRequest

Static Fields

MUTATION_KEY_FIELD_NUMBER

public static final int MUTATION_KEY_FIELD_NUMBER
Field Value
Type Description
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_OPTIONS_FIELD_NUMBER

public static final int REQUEST_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BeginTransactionRequest getDefaultInstance()
Returns
Type Description
BeginTransactionRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BeginTransactionRequest.Builder newBuilder()
Returns
Type Description
BeginTransactionRequest.Builder

newBuilder(BeginTransactionRequest prototype)

public static BeginTransactionRequest.Builder newBuilder(BeginTransactionRequest prototype)
Parameter
Name Description
prototype BeginTransactionRequest
Returns
Type Description
BeginTransactionRequest.Builder

parseDelimitedFrom(InputStream input)

public static BeginTransactionRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BeginTransactionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BeginTransactionRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BeginTransactionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BeginTransactionRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BeginTransactionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BeginTransactionRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BeginTransactionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BeginTransactionRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BeginTransactionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BeginTransactionRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BeginTransactionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BeginTransactionRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BeginTransactionRequest> parser()
Returns
Type Description
Parser<BeginTransactionRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public BeginTransactionRequest getDefaultInstanceForType()
Returns
Type Description
BeginTransactionRequest

getMutationKey()

public Mutation getMutationKey()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Mutation

The mutationKey.

getMutationKeyOrBuilder()

public MutationOrBuilder getMutationKeyOrBuilder()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MutationOrBuilder

getOptions()

public TransactionOptions getOptions()

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransactionOptions

The options.

getOptionsOrBuilder()

public TransactionOptionsOrBuilder getOptionsOrBuilder()

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransactionOptionsOrBuilder

getParserForType()

public Parser<BeginTransactionRequest> getParserForType()
Returns
Type Description
Parser<BeginTransactionRequest>
Overrides

getRequestOptions()

public RequestOptions getRequestOptions()

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Returns
Type Description
RequestOptions

The requestOptions.

getRequestOptionsOrBuilder()

public RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Returns
Type Description
RequestOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSession()

public String getSession()

Required. The session in which the transaction runs.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The session.

getSessionBytes()

public ByteString getSessionBytes()

Required. The session in which the transaction runs.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for session.

hasMutationKey()

public boolean hasMutationKey()

Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.Mutation mutation_key = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the mutationKey field is set.

hasOptions()

public boolean hasOptions()

Required. Options for the new transaction.

.google.spanner.v1.TransactionOptions options = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the options field is set.

hasRequestOptions()

public boolean hasRequestOptions()

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

.google.spanner.v1.RequestOptions request_options = 3;

Returns
Type Description
boolean

Whether the requestOptions field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BeginTransactionRequest.Builder newBuilderForType()
Returns
Type Description
BeginTransactionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BeginTransactionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BeginTransactionRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BeginTransactionRequest.Builder toBuilder()
Returns
Type Description
BeginTransactionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException