public static final class WriteResponse.Builder extends GeneratedMessageV3.Builder<WriteResponse.Builder> implements WriteResponseOrBuilderThe response for Firestore.Write.
Protobuf type google.firestore.v1.WriteResponse
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WriteResponse.BuilderImplements
WriteResponseOrBuilderStatic 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 |
|
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 |
|
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 |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public WriteResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
WriteResponse.Builder |
|
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 |
|
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 |
|
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public WriteResponse.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
WriteResponse.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final WriteResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WriteResponse.Builder |
|
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 |
|
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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
ByteStringThe 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 |
|
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 |
|