Class WriteResponse (3.22.0)

public final class WriteResponse extends GeneratedMessageV3 implements WriteResponseOrBuilder

The response for Firestore.Write.

Protobuf type google.firestore.v1.WriteResponse

Static Fields

COMMIT_TIME_FIELD_NUMBER

public static final int COMMIT_TIME_FIELD_NUMBER
Field Value
Type Description
int

STREAM_ID_FIELD_NUMBER

public static final int STREAM_ID_FIELD_NUMBER
Field Value
Type Description
int

STREAM_TOKEN_FIELD_NUMBER

public static final int STREAM_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

WRITE_RESULTS_FIELD_NUMBER

public static final int WRITE_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WriteResponse getDefaultInstance()
Returns
Type Description
WriteResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static WriteResponse.Builder newBuilder()
Returns
Type Description
WriteResponse.Builder

newBuilder(WriteResponse prototype)

public static WriteResponse.Builder newBuilder(WriteResponse prototype)
Parameter
Name Description
prototype WriteResponse
Returns
Type Description
WriteResponse.Builder

parseDelimitedFrom(InputStream input)

public static WriteResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WriteResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WriteResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WriteResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WriteResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WriteResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WriteResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WriteResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WriteResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WriteResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WriteResponse> parser()
Returns
Type Description
Parser<WriteResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
Timestamp

The commitTime.

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

getParserForType()

public Parser<WriteResponse> getParserForType()
Returns
Type Description
Parser<WriteResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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
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

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WriteResponse.Builder newBuilderForType()
Returns
Type Description
WriteResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WriteResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WriteResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public WriteResponse.Builder toBuilder()
Returns
Type Description
WriteResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException