Class CommitRequest.Builder (3.22.0)

Version 3.22.0

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class CommitRequest.Builder extends GeneratedMessageV3.Builder<CommitRequest.Builder> implements CommitRequestOrBuilder

The request for Firestore.Commit.

Protobuf type google.firestore.v1.CommitRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CommitRequest.Builder

Implements

CommitRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllWrites(Iterable<? extends Write> values)

public CommitRequest.Builder addAllWrites(Iterable<? extends Write> values)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameter
Name	Description
values	Iterable<? extends com.google.firestore.v1.Write>

Returns
Type	Description
CommitRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CommitRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CommitRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addWrites(Write value)

public CommitRequest.Builder addWrites(Write value)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameter
Name	Description
value	Write

Returns
Type	Description
CommitRequest.Builder

addWrites(Write.Builder builderForValue)

public CommitRequest.Builder addWrites(Write.Builder builderForValue)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameter
Name	Description
builderForValue	Write.Builder

Returns
Type	Description
CommitRequest.Builder

addWrites(int index, Write value)

public CommitRequest.Builder addWrites(int index, Write value)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameters
Name	Description
index	int
value	Write

Returns
Type	Description
CommitRequest.Builder

addWrites(int index, Write.Builder builderForValue)

public CommitRequest.Builder addWrites(int index, Write.Builder builderForValue)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameters
Name	Description
index	int
builderForValue	Write.Builder

Returns
Type	Description
CommitRequest.Builder

addWritesBuilder()

public Write.Builder addWritesBuilder()

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Returns
Type	Description
Write.Builder

addWritesBuilder(int index)

public Write.Builder addWritesBuilder(int index)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Write.Builder

build()

public CommitRequest build()

Returns
Type	Description
CommitRequest

buildPartial()

public CommitRequest buildPartial()

Returns
Type	Description
CommitRequest

clear()

public CommitRequest.Builder clear()

Returns
Type	Description
CommitRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDatabase()

public CommitRequest.Builder clearDatabase()

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

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

Returns
Type	Description
CommitRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CommitRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CommitRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CommitRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CommitRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearTransaction()

public CommitRequest.Builder clearTransaction()

If set, applies all writes in this transaction, and commits it.

bytes transaction = 3;

Returns
Type	Description
CommitRequest.Builder	This builder for chaining.

clearWrites()

public CommitRequest.Builder clearWrites()

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Returns
Type	Description
CommitRequest.Builder

clone()

public CommitRequest.Builder clone()

Returns
Type	Description
CommitRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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 CommitRequest getDefaultInstanceForType()

Returns
Type	Description
CommitRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getTransaction()

public ByteString getTransaction()

If set, applies all writes in this transaction, and commits it.

bytes transaction = 3;

Returns
Type	Description
ByteString	The transaction.

getWrites(int index)

public Write getWrites(int index)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Write

getWritesBuilder(int index)

public Write.Builder getWritesBuilder(int index)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Write.Builder

getWritesBuilderList()

public List<Write.Builder> getWritesBuilderList()

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Returns
Type	Description
List<Builder>

getWritesCount()

public int getWritesCount()

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Returns
Type	Description
int

getWritesList()

public List<Write> getWritesList()

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Returns
Type	Description
List<Write>

getWritesOrBuilder(int index)

public WriteOrBuilder getWritesOrBuilder(int index)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
WriteOrBuilder

getWritesOrBuilderList()

public List<? extends WriteOrBuilder> getWritesOrBuilderList()

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Returns
Type	Description
List<? extends com.google.firestore.v1.WriteOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CommitRequest other)

public CommitRequest.Builder mergeFrom(CommitRequest other)

Parameter
Name	Description
other	CommitRequest

Returns
Type	Description
CommitRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CommitRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CommitRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CommitRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CommitRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CommitRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CommitRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeWrites(int index)

public CommitRequest.Builder removeWrites(int index)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
CommitRequest.Builder

setDatabase(String value)

public CommitRequest.Builder setDatabase(String value)

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

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

Parameter
Name	Description
value	String The database to set.

Returns
Type	Description
CommitRequest.Builder	This builder for chaining.

setDatabaseBytes(ByteString value)

public CommitRequest.Builder setDatabaseBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for database to set.

Returns
Type	Description
CommitRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CommitRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CommitRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CommitRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CommitRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTransaction(ByteString value)

public CommitRequest.Builder setTransaction(ByteString value)

If set, applies all writes in this transaction, and commits it.

bytes transaction = 3;

Parameter
Name	Description
value	ByteString The transaction to set.

Returns
Type	Description
CommitRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CommitRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CommitRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setWrites(int index, Write value)

public CommitRequest.Builder setWrites(int index, Write value)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameters
Name	Description
index	int
value	Write

Returns
Type	Description
CommitRequest.Builder

setWrites(int index, Write.Builder builderForValue)

public CommitRequest.Builder setWrites(int index, Write.Builder builderForValue)

The writes to apply.

Always executed atomically and in order.

repeated .google.firestore.v1.Write writes = 2;

Parameters
Name	Description
index	int
builderForValue	Write.Builder

Returns
Type	Description
CommitRequest.Builder