Class BatchWriteRequest (3.17.0)

public final class BatchWriteRequest extends GeneratedMessageV3 implements BatchWriteRequestOrBuilder

The request for Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteRequest

Static Fields

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

WRITES_FIELD_NUMBER

public static final int WRITES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchWriteRequest getDefaultInstance()
Returns
TypeDescription
BatchWriteRequest

getDescriptor()

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

newBuilder()

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

newBuilder(BatchWriteRequest prototype)

public static BatchWriteRequest.Builder newBuilder(BatchWriteRequest prototype)
Parameter
NameDescription
prototypeBatchWriteRequest
Returns
TypeDescription
BatchWriteRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels associated with this batch write.

map<string, string> labels = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getDatabase()

public String getDatabase()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for database.

getDefaultInstanceForType()

public BatchWriteRequest getDefaultInstanceForType()
Returns
TypeDescription
BatchWriteRequest

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels associated with this batch write.

map<string, string> labels = 3;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels associated with this batch write.

map<string, string> labels = 3;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels associated with this batch write.

map<string, string> labels = 3;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels associated with this batch write.

map<string, string> labels = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getWrites(int index)

public Write getWrites(int index)

The writes to apply.

Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.

repeated .google.firestore.v1.Write writes = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
Write

getWritesCount()

public int getWritesCount()

The writes to apply.

Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.

repeated .google.firestore.v1.Write writes = 2;

Returns
TypeDescription
int

getWritesList()

public List<Write> getWritesList()

The writes to apply.

Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.

repeated .google.firestore.v1.Write writes = 2;

Returns
TypeDescription
List<Write>

getWritesOrBuilder(int index)

public WriteOrBuilder getWritesOrBuilder(int index)

The writes to apply.

Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.

repeated .google.firestore.v1.Write writes = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
WriteOrBuilder

getWritesOrBuilderList()

public List<? extends WriteOrBuilder> getWritesOrBuilderList()

The writes to apply.

Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.

repeated .google.firestore.v1.Write writes = 2;

Returns
TypeDescription
List<? extends com.google.firestore.v1.WriteOrBuilder>

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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