Class WriteResult (3.30.0)

public final class WriteResult extends GeneratedMessageV3 implements WriteResultOrBuilder

The result of applying a write.

Protobuf type google.firestore.v1.WriteResult

Static Fields

TRANSFORM_RESULTS_FIELD_NUMBER

public static final int TRANSFORM_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WriteResult getDefaultInstance()
Returns
Type Description
WriteResult

getDescriptor()

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

newBuilder()

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

newBuilder(WriteResult prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public WriteResult getDefaultInstanceForType()
Returns
Type Description
WriteResult

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTransformResults(int index)

public Value getTransformResults(int index)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name Description
index int
Returns
Type Description
Value

getTransformResultsCount()

public int getTransformResultsCount()

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Returns
Type Description
int

getTransformResultsList()

public List<Value> getTransformResultsList()

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Returns
Type Description
List<Value>

getTransformResultsOrBuilder(int index)

public ValueOrBuilder getTransformResultsOrBuilder(int index)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name Description
index int
Returns
Type Description
ValueOrBuilder

getTransformResultsOrBuilderList()

public List<? extends ValueOrBuilder> getTransformResultsOrBuilderList()

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

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

getUpdateTime()

public Timestamp getUpdateTime()

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Returns
Type Description
TimestampOrBuilder

hasUpdateTime()

public boolean hasUpdateTime()

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Returns
Type Description
boolean

Whether the updateTime 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 WriteResult.Builder newBuilderForType()
Returns
Type Description
WriteResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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