com.google.firestore.v1beta1

Interface WriteRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

WriteRequest, WriteRequest.Builder

public interface WriteRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.String key) Labels associated with this write request.
java.lang.String	getDatabase() The database name.
ByteString	getDatabaseBytes() The database name.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
int	getLabelsCount() Labels associated with this write request.
java.util.Map<java.lang.String,java.lang.String>	getLabelsMap() Labels associated with this write request.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) Labels associated with this write request.
java.lang.String	getLabelsOrThrow(java.lang.String key) Labels associated with this write request.
java.lang.String	getStreamId() The ID of the write stream to resume.
ByteString	getStreamIdBytes() The ID of the write stream to resume.
ByteString	getStreamToken() A stream token that was previously sent by the server.
Write	getWrites(int index) The writes to apply.
int	getWritesCount() The writes to apply.
java.util.List<Write>	getWritesList() The writes to apply.
WriteOrBuilder	getWritesOrBuilder(int index) The writes to apply.
java.util.List<? extends WriteOrBuilder>	getWritesOrBuilderList() The writes to apply.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getDatabase

java.lang.String getDatabase()

 The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
 This is only required in the first message.
 

string database = 1;

getDatabaseBytes

ByteString getDatabaseBytes()

 The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
 This is only required in the first message.
 

string database = 1;

getStreamId

java.lang.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;

getStreamIdBytes

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;

getWritesList

java.util.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.v1beta1.Write writes = 3;

getWrites

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.v1beta1.Write writes = 3;

getWritesCount

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.v1beta1.Write writes = 3;

getWritesOrBuilderList

java.util.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.v1beta1.Write writes = 3;

getWritesOrBuilder

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.v1beta1.Write writes = 3;

getStreamToken

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][google.firestore.v1beta1.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;

getLabelsCount

int getLabelsCount()

 Labels associated with this write request.
 

map<string, string> labels = 5;

containsLabels

boolean containsLabels(java.lang.String key)

 Labels associated with this write request.
 

map<string, string> labels = 5;

getLabels

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

java.util.Map<java.lang.String,java.lang.String> getLabelsMap()

 Labels associated with this write request.
 

map<string, string> labels = 5;

getLabelsOrDefault

java.lang.String getLabelsOrDefault(java.lang.String key,
                                    java.lang.String defaultValue)

 Labels associated with this write request.
 

map<string, string> labels = 5;

getLabelsOrThrow

java.lang.String getLabelsOrThrow(java.lang.String key)

 Labels associated with this write request.
 

map<string, string> labels = 5;