Send feedback
Class BatchWriteRequest (3.14.4)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.14.4 keyboard_arrow_down
public final class BatchWriteRequest extends GeneratedMessageV3 implements BatchWriteRequestOrBuilder
The request for
Firestore.BatchWrite .
Protobuf type google.firestore.v1.BatchWriteRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
DATABASE_FIELD_NUMBER
public static final int DATABASE_FIELD_NUMBER
Field Value Type Description int
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value Type Description int
WRITES_FIELD_NUMBER
public static final int WRITES_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static BatchWriteRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static BatchWriteRequest . Builder newBuilder ()
newBuilder(BatchWriteRequest prototype)
public static BatchWriteRequest . Builder newBuilder ( BatchWriteRequest prototype )
public static BatchWriteRequest parseDelimitedFrom ( InputStream input )
public static BatchWriteRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static BatchWriteRequest parseFrom ( byte [] data )
Parameter Name Description data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchWriteRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static BatchWriteRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchWriteRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static BatchWriteRequest parseFrom ( CodedInputStream input )
public static BatchWriteRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static BatchWriteRequest parseFrom ( InputStream input )
public static BatchWriteRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static BatchWriteRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchWriteRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<BatchWriteRequest> parser ()
Methods
containsLabels(String key)
public boolean containsLabels ( String key )
Labels associated with this batch write.
map<string, string> labels = 3;
Parameter Name Description key
String
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description obj
Object
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 Type Description 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 Type Description ByteString
The bytes for database.
getDefaultInstanceForType()
public BatchWriteRequest getDefaultInstanceForType ()
getLabels()
public Map<String , String > getLabels ()
getLabelsCount()
public int getLabelsCount ()
Labels associated with this batch write.
map<string, string> labels = 3;
Returns Type Description int
getLabelsMap()
public Map<String , String > getLabelsMap ()
Labels associated with this batch write.
map<string, string> labels = 3;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault ( String key , String defaultValue )
Labels associated with this batch write.
map<string, string> labels = 3;
getLabelsOrThrow(String key)
public String getLabelsOrThrow ( String key )
Labels associated with this batch write.
map<string, string> labels = 3;
Parameter Name Description key
String
getParserForType()
public Parser<BatchWriteRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns Type Description 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 Name Description index
int
Returns Type Description 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 Type Description 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;
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 Name Description index
int
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 Type Description List <? extends com.google.firestore.v1.WriteOrBuilder >
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField ( int number )
Parameter Name Description number
int
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public BatchWriteRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchWriteRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public BatchWriteRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]