Class BeginTransactionRequest (3.49.0)

public final class BeginTransactionRequest extends GeneratedMessage implements BeginTransactionRequestOrBuilder

The request for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionRequest

Inheritance

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

Implements

BeginTransactionRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DATABASE_FIELD_NUMBER

public static final int DATABASE_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`

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

AbstractMessage.equals(Object other)

getDatabase()

public String getDatabase()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for database.

getDefaultInstanceForType()

public BeginTransactionRequest getDefaultInstanceForType()

Returns
Type	Description
`BeginTransactionRequest`

getOptions()

public TransactionOptions getOptions()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns
Type	Description
`TransactionOptions`	The options.

getOptionsOrBuilder()

public TransactionOptionsOrBuilder getOptionsOrBuilder()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns
Type	Description
`TransactionOptionsOrBuilder`

getParserForType()

public Parser<BeginTransactionRequest> getParserForType()

Returns
Type	Description
`Parser<BeginTransactionRequest>`

Overrides

GeneratedMessage.getParserForType()

getRequestOptions()

public RequestOptions getRequestOptions()

Optional. Any additional options for the request.

.google.firestore.v1.RequestOptions request_options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RequestOptions`	The requestOptions.

getRequestOptionsOrBuilder()

public RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Optional. Any additional options for the request.

.google.firestore.v1.RequestOptions request_options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`RequestOptionsOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

hasOptions()

public boolean hasOptions()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns
Type	Description
`boolean`	Whether the options field is set.

hasRequestOptions()

public boolean hasRequestOptions()

Optional. Any additional options for the request.

.google.firestore.v1.RequestOptions request_options = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the requestOptions field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public BeginTransactionRequest.Builder newBuilderForType()

Returns
Type	Description
`BeginTransactionRequest.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected BeginTransactionRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`BeginTransactionRequest.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public BeginTransactionRequest.Builder toBuilder()

Returns
Type	Description
`BeginTransactionRequest.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`

Class BeginTransactionRequest (3.49.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Fields

DATABASE_FIELD_NUMBER

OPTIONS_FIELD_NUMBER

REQUEST_OPTIONS_FIELD_NUMBER

Static Methods

getDefaultInstance()

getDescriptor()

newBuilder()

newBuilder(BeginTransactionRequest prototype)

parseDelimitedFrom(InputStream input)

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(byte[] data)

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteString data)

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

parseFrom(CodedInputStream input)

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(InputStream input)

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteBuffer data)

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

parser()

Methods

equals(Object obj)

getDatabase()

getDatabaseBytes()

getDefaultInstanceForType()

getOptions()

getOptionsOrBuilder()

getParserForType()

getRequestOptions()

getRequestOptionsOrBuilder()

getSerializedSize()

hasOptions()

hasRequestOptions()

hashCode()

internalGetFieldAccessorTable()

isInitialized()

newBuilderForType()

newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

writeTo(CodedOutputStream output)

Class BeginTransactionRequest (3.49.0)