Class WriteResult (3.6.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
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static WriteResult getDefaultInstance()
Returns
TypeDescription
WriteResult

getDescriptor()

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

newBuilder()

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

newBuilder(WriteResult prototype)

public static WriteResult.Builder newBuilder(WriteResult prototype)
Parameter
NameDescription
prototypeWriteResult
Returns
TypeDescription
WriteResult.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public WriteResult getDefaultInstanceForType()
Returns
TypeDescription
WriteResult

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.firestore.v1.ValueOrBuilder>

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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

Whether the updateTime 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

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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