Class WriteResponse

public final class WriteResponse extends GeneratedMessageV3 implements WriteResponseOrBuilder

The response for Firestore.Write.

Protobuf type google.firestore.v1.WriteResponse

Fields

COMMIT_TIME_FIELD_NUMBER

public static final int COMMIT_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STREAM_ID_FIELD_NUMBER

public static final int STREAM_ID_FIELD_NUMBER
Field Value
TypeDescription
int

STREAM_TOKEN_FIELD_NUMBER

public static final int STREAM_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

WRITE_RESULTS_FIELD_NUMBER

public static final int WRITE_RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstance()

public static WriteResponse getDefaultInstance()
Returns
TypeDescription
WriteResponse

getDefaultInstanceForType()

public WriteResponse getDefaultInstanceForType()
Returns
TypeDescription
WriteResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getParserForType()

public Parser<WriteResponse> getParserForType()
Returns
TypeDescription
Parser<WriteResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static WriteResponse.Builder newBuilder()
Returns
TypeDescription
WriteResponse.Builder

newBuilder(WriteResponse prototype)

public static WriteResponse.Builder newBuilder(WriteResponse prototype)
Parameter
NameDescription
prototypeWriteResponse
Returns
TypeDescription
WriteResponse.Builder

newBuilderForType()

public WriteResponse.Builder newBuilderForType()
Returns
TypeDescription
WriteResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WriteResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
WriteResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static WriteResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static WriteResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WriteResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WriteResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static WriteResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static WriteResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WriteResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<WriteResponse> parser()
Returns
TypeDescription
Parser<WriteResponse>

toBuilder()

public WriteResponse.Builder toBuilder()
Returns
TypeDescription
WriteResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException