public interface WriteRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)Labels associated with this write request.
map<string, string> labels = 5;
| 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}.
This is only required in the first message.
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}.
This is only required in the first message.
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 write request.
map<string, string> labels = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public abstract Map<String,String> getLabelsMap()Labels associated with this write request.
map<string, string> labels = 5;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue)Labels associated with this write request.
map<string, string> labels = 5;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key)Labels associated with this write request.
map<string, string> labels = 5;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getStreamId()
public abstract String getStreamId()The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.
string stream_id = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The streamId. |
getStreamIdBytes()
public abstract ByteString getStreamIdBytes()The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.
string stream_id = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for streamId. |
getStreamToken()
public abstract ByteString getStreamToken()A stream token that was previously sent by the server.
The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore.
The server may close the stream if there are too many unacknowledged responses.
Leave this field unset when creating a new stream. To resume a stream at
a specific point, set this field and the stream_id field.
Leave this field unset when creating a new stream.
bytes stream_token = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The streamToken. |
getWrites(int index)
public abstract Write getWrites(int index)The writes to apply.
Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.
repeated .google.firestore.v1.Write writes = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Write |
|
getWritesCount()
public abstract int getWritesCount()The writes to apply.
Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.
repeated .google.firestore.v1.Write writes = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
getWritesList()
public abstract List<Write> getWritesList()The writes to apply.
Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.
repeated .google.firestore.v1.Write writes = 3;
| Returns | |
|---|---|
| Type | Description |
List<Write> |
|
getWritesOrBuilder(int index)
public abstract WriteOrBuilder getWritesOrBuilder(int index)The writes to apply.
Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.
repeated .google.firestore.v1.Write writes = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
WriteOrBuilder |
|
getWritesOrBuilderList()
public abstract List<? extends WriteOrBuilder> getWritesOrBuilderList()The writes to apply.
Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.
repeated .google.firestore.v1.Write writes = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.firestore.v1.WriteOrBuilder> |
|