Class WriteResponse.Builder (3.12.1)

Version 3.12.1

• 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 WriteResponse.Builder extends GeneratedMessageV3.Builder<WriteResponse.Builder> implements WriteResponseOrBuilder

The response for Firestore.Write.

Protobuf type google.firestore.v1.WriteResponse

Inheritance

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

Implements

WriteResponseOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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

addAllWriteResults(Iterable<? extends WriteResult> values)

public WriteResponse.Builder addAllWriteResults(Iterable<? extends WriteResult> values)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

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

Returns
Type	Description
WriteResponse.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
WriteResponse.Builder

Overrides

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

addWriteResults(WriteResult value)

public WriteResponse.Builder addWriteResults(WriteResult value)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameter
Name	Description
value	WriteResult

Returns
Type	Description
WriteResponse.Builder

addWriteResults(WriteResult.Builder builderForValue)

public WriteResponse.Builder addWriteResults(WriteResult.Builder builderForValue)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameter
Name	Description
builderForValue	WriteResult.Builder

Returns
Type	Description
WriteResponse.Builder

addWriteResults(int index, WriteResult value)

public WriteResponse.Builder addWriteResults(int index, WriteResult value)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameters
Name	Description
index	int
value	WriteResult

Returns
Type	Description
WriteResponse.Builder

addWriteResults(int index, WriteResult.Builder builderForValue)

public WriteResponse.Builder addWriteResults(int index, WriteResult.Builder builderForValue)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameters
Name	Description
index	int
builderForValue	WriteResult.Builder

Returns
Type	Description
WriteResponse.Builder

addWriteResultsBuilder()

public WriteResult.Builder addWriteResultsBuilder()

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Returns
Type	Description
WriteResult.Builder

addWriteResultsBuilder(int index)

public WriteResult.Builder addWriteResultsBuilder(int index)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
WriteResult.Builder

build()

public WriteResponse build()

Returns
Type	Description
WriteResponse

buildPartial()

public WriteResponse buildPartial()

Returns
Type	Description
WriteResponse

clear()

public WriteResponse.Builder clear()

Returns
Type	Description
WriteResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCommitTime()

public WriteResponse.Builder clearCommitTime()

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

.google.protobuf.Timestamp commit_time = 4;

Returns
Type	Description
WriteResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public WriteResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
WriteResponse.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
WriteResponse.Builder

Overrides

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

clearStreamId()

public WriteResponse.Builder clearStreamId()

The ID of the stream. Only set on the first message, when a new stream was created.

string stream_id = 1;

Returns
Type	Description
WriteResponse.Builder	This builder for chaining.

clearStreamToken()

public WriteResponse.Builder clearStreamToken()

A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set.

bytes stream_token = 2;

Returns
Type	Description
WriteResponse.Builder	This builder for chaining.

clearWriteResults()

public WriteResponse.Builder clearWriteResults()

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Returns
Type	Description
WriteResponse.Builder

clone()

public WriteResponse.Builder clone()

Returns
Type	Description
WriteResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCommitTime()

public Timestamp getCommitTime()

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

.google.protobuf.Timestamp commit_time = 4;

Returns
Type	Description
Timestamp	The commitTime.

getCommitTimeBuilder()

public Timestamp.Builder getCommitTimeBuilder()

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

.google.protobuf.Timestamp commit_time = 4;

Returns
Type	Description
Builder

getCommitTimeOrBuilder()

public TimestampOrBuilder getCommitTimeOrBuilder()

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

.google.protobuf.Timestamp commit_time = 4;

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public WriteResponse getDefaultInstanceForType()

Returns
Type	Description
WriteResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getStreamId()

public String getStreamId()

The ID of the stream. Only set on the first message, when a new stream was created.

string stream_id = 1;

Returns
Type	Description
String	The streamId.

getStreamIdBytes()

public ByteString getStreamIdBytes()

The ID of the stream. Only set on the first message, when a new stream was created.

string stream_id = 1;

Returns
Type	Description
ByteString	The bytes for streamId.

getStreamToken()

public ByteString getStreamToken()

A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set.

bytes stream_token = 2;

Returns
Type	Description
ByteString	The streamToken.

getWriteResults(int index)

public WriteResult getWriteResults(int index)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
WriteResult

getWriteResultsBuilder(int index)

public WriteResult.Builder getWriteResultsBuilder(int index)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
WriteResult.Builder

getWriteResultsBuilderList()

public List<WriteResult.Builder> getWriteResultsBuilderList()

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Returns
Type	Description
List<Builder>

getWriteResultsCount()

public int getWriteResultsCount()

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Returns
Type	Description
int

getWriteResultsList()

public List<WriteResult> getWriteResultsList()

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Returns
Type	Description
List<WriteResult>

getWriteResultsOrBuilder(int index)

public WriteResultOrBuilder getWriteResultsOrBuilder(int index)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
WriteResultOrBuilder

getWriteResultsOrBuilderList()

public List<? extends WriteResultOrBuilder> getWriteResultsOrBuilderList()

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

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

hasCommitTime()

public boolean hasCommitTime()

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

.google.protobuf.Timestamp commit_time = 4;

Returns
Type	Description
boolean	Whether the commitTime field is set.

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

mergeCommitTime(Timestamp value)

public WriteResponse.Builder mergeCommitTime(Timestamp value)

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

.google.protobuf.Timestamp commit_time = 4;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
WriteResponse.Builder

mergeFrom(WriteResponse other)

public WriteResponse.Builder mergeFrom(WriteResponse other)

Parameter
Name	Description
other	WriteResponse

Returns
Type	Description
WriteResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
WriteResponse.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public WriteResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
WriteResponse.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
WriteResponse.Builder

Overrides

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

removeWriteResults(int index)

public WriteResponse.Builder removeWriteResults(int index)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
WriteResponse.Builder

setCommitTime(Timestamp value)

public WriteResponse.Builder setCommitTime(Timestamp value)

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

.google.protobuf.Timestamp commit_time = 4;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
WriteResponse.Builder

setCommitTime(Timestamp.Builder builderForValue)

public WriteResponse.Builder setCommitTime(Timestamp.Builder builderForValue)

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

.google.protobuf.Timestamp commit_time = 4;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
WriteResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
WriteResponse.Builder

Overrides

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

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
WriteResponse.Builder

Overrides

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

setStreamId(String value)

public WriteResponse.Builder setStreamId(String value)

The ID of the stream. Only set on the first message, when a new stream was created.

string stream_id = 1;

Parameter
Name	Description
value	String The streamId to set.

Returns
Type	Description
WriteResponse.Builder	This builder for chaining.

setStreamIdBytes(ByteString value)

public WriteResponse.Builder setStreamIdBytes(ByteString value)

The ID of the stream. Only set on the first message, when a new stream was created.

string stream_id = 1;

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

Returns
Type	Description
WriteResponse.Builder	This builder for chaining.

setStreamToken(ByteString value)

public WriteResponse.Builder setStreamToken(ByteString value)

A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set.

bytes stream_token = 2;

Parameter
Name	Description
value	ByteString The streamToken to set.

Returns
Type	Description
WriteResponse.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final WriteResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
WriteResponse.Builder

Overrides

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

setWriteResults(int index, WriteResult value)

public WriteResponse.Builder setWriteResults(int index, WriteResult value)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameters
Name	Description
index	int
value	WriteResult

Returns
Type	Description
WriteResponse.Builder

setWriteResults(int index, WriteResult.Builder builderForValue)

public WriteResponse.Builder setWriteResults(int index, WriteResult.Builder builderForValue)

The result of applying the writes. This i-th write result corresponds to the i-th write in the request.

repeated .google.firestore.v1.WriteResult write_results = 3;

Parameters
Name	Description
index	int
builderForValue	WriteResult.Builder

Returns
Type	Description
WriteResponse.Builder