Interface BatchWriteRequestOrBuilder (3.22.0)

public interface BatchWriteRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels associated with this batch write.

map<string, string> labels = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDatabase()

public abstract 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 abstract 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.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels associated with this batch write.

map<string, string> labels = 3;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels associated with this batch write.

map<string, string> labels = 3;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels associated with this batch write.

map<string, string> labels = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels associated with this batch write.

map<string, string> labels = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getWrites(int index)

public abstract 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 abstract 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 abstract 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
Type Description
List<Write>

getWritesOrBuilder(int index)

public abstract 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
Returns
Type Description
WriteOrBuilder

getWritesOrBuilderList()

public abstract 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>