Class WriteResponse.Builder (3.14.1-SNAPSHOT)

public static final class WriteResponse.Builder extends GeneratedMessageV3.Builder<WriteResponse.Builder> implements WriteResponseOrBuilder

The response for Firestore.Write.

Protobuf type google.firestore.v1.WriteResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.firestore.v1.WriteResult>
Returns
TypeDescription
WriteResponse.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WriteResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WriteResponse.Builder
Overrides

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
NameDescription
valueWriteResult
Returns
TypeDescription
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
NameDescription
builderForValueWriteResult.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueWriteResult
Returns
TypeDescription
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
NameDescription
indexint
builderForValueWriteResult.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
WriteResult.Builder

build()

public WriteResponse build()
Returns
TypeDescription
WriteResponse

buildPartial()

public WriteResponse buildPartial()
Returns
TypeDescription
WriteResponse

clear()

public WriteResponse.Builder clear()
Returns
TypeDescription
WriteResponse.Builder
Overrides

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
TypeDescription
WriteResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public WriteResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
WriteResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
WriteResponse.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
WriteResponse.Builder

clone()

public WriteResponse.Builder clone()
Returns
TypeDescription
WriteResponse.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public WriteResponse getDefaultInstanceForType()
Returns
TypeDescription
WriteResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the commitTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
WriteResponse.Builder

mergeFrom(WriteResponse other)

public WriteResponse.Builder mergeFrom(WriteResponse other)
Parameter
NameDescription
otherWriteResponse
Returns
TypeDescription
WriteResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WriteResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteResponse.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public WriteResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
WriteResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WriteResponse.Builder
Overrides

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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
WriteResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WriteResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WriteResponse.Builder
Overrides

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

public WriteResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
WriteResponse.Builder
Overrides

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
NameDescription
valueString

The streamId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for streamId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The streamToken to set.

Returns
TypeDescription
WriteResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final WriteResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WriteResponse.Builder
Overrides

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
NameDescription
indexint
valueWriteResult
Returns
TypeDescription
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
NameDescription
indexint
builderForValueWriteResult.Builder
Returns
TypeDescription
WriteResponse.Builder