Class BatchWriteResponse (3.22.0)

public final class BatchWriteResponse extends GeneratedMessageV3 implements BatchWriteResponseOrBuilder

The response from Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteResponse

Static Fields

STATUS_FIELD_NUMBER

public static final int STATUS_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 BatchWriteResponse getDefaultInstance()
Returns
Type Description
BatchWriteResponse

getDescriptor()

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

newBuilder()

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

newBuilder(BatchWriteResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchWriteResponse getDefaultInstanceForType()
Returns
Type Description
BatchWriteResponse

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus(int index)

public Status getStatus(int index)

The status of applying the writes.

This i-th write status corresponds to the i-th write in the request.

repeated .google.rpc.Status status = 2;

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status

getStatusCount()

public int getStatusCount()

The status of applying the writes.

This i-th write status corresponds to the i-th write in the request.

repeated .google.rpc.Status status = 2;

Returns
Type Description
int

getStatusList()

public List<Status> getStatusList()

The status of applying the writes.

This i-th write status corresponds to the i-th write in the request.

repeated .google.rpc.Status status = 2;

Returns
Type Description
List<com.google.rpc.Status>

getStatusOrBuilder(int index)

public StatusOrBuilder getStatusOrBuilder(int index)

The status of applying the writes.

This i-th write status corresponds to the i-th write in the request.

repeated .google.rpc.Status status = 2;

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.StatusOrBuilder

getStatusOrBuilderList()

public List<? extends StatusOrBuilder> getStatusOrBuilderList()

The status of applying the writes.

This i-th write status corresponds to the i-th write in the request.

repeated .google.rpc.Status status = 2;

Returns
Type Description
List<? extends com.google.rpc.StatusOrBuilder>

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 = 1;

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 = 1;

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 = 1;

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 = 1;

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 = 1;

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

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 BatchWriteResponse.Builder newBuilderForType()
Returns
Type Description
BatchWriteResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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