Class CloseBatchTransactionAction (6.56.0)

public final class CloseBatchTransactionAction extends GeneratedMessageV3 implements CloseBatchTransactionActionOrBuilder

Closes or cleans up the currently opened batch read-only transaction.

Once a transaction is closed, the Executor can be disposed of or used to start start another transaction. Closing a batch transaction in one Executor doesn't affect the transaction's state in other Executors that also read from it.

When a transaction is cleaned up, it becomes globally invalid. Cleaning up is optional, but recommended.

Protobuf type google.spanner.executor.v1.CloseBatchTransactionAction

Static Fields

CLEANUP_FIELD_NUMBER

public static final int CLEANUP_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CloseBatchTransactionAction getDefaultInstance()
Returns
TypeDescription
CloseBatchTransactionAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CloseBatchTransactionAction.Builder newBuilder()
Returns
TypeDescription
CloseBatchTransactionAction.Builder

newBuilder(CloseBatchTransactionAction prototype)

public static CloseBatchTransactionAction.Builder newBuilder(CloseBatchTransactionAction prototype)
Parameter
NameDescription
prototypeCloseBatchTransactionAction
Returns
TypeDescription
CloseBatchTransactionAction.Builder

parseDelimitedFrom(InputStream input)

public static CloseBatchTransactionAction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloseBatchTransactionAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CloseBatchTransactionAction parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CloseBatchTransactionAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CloseBatchTransactionAction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CloseBatchTransactionAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CloseBatchTransactionAction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CloseBatchTransactionAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CloseBatchTransactionAction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloseBatchTransactionAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CloseBatchTransactionAction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CloseBatchTransactionAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloseBatchTransactionAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CloseBatchTransactionAction> parser()
Returns
TypeDescription
Parser<CloseBatchTransactionAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCleanup()

public boolean getCleanup()

Indicates whether the transaction needs to be cleaned up.

bool cleanup = 1;

Returns
TypeDescription
boolean

The cleanup.

getDefaultInstanceForType()

public CloseBatchTransactionAction getDefaultInstanceForType()
Returns
TypeDescription
CloseBatchTransactionAction

getParserForType()

public Parser<CloseBatchTransactionAction> getParserForType()
Returns
TypeDescription
Parser<CloseBatchTransactionAction>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CloseBatchTransactionAction.Builder newBuilderForType()
Returns
TypeDescription
CloseBatchTransactionAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CloseBatchTransactionAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CloseBatchTransactionAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CloseBatchTransactionAction.Builder toBuilder()
Returns
TypeDescription
CloseBatchTransactionAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException