Package com.google.firestore.v1

Interface WriteRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
WriteRequest, WriteRequest.Builder
public interface WriteRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getDatabase

      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:
      The database.

    • getDatabaseBytes

      com.google.protobuf.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:
      The bytes for database.

    • getStreamId

      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:
      The streamId.

    • getStreamIdBytes

      com.google.protobuf.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:
      The bytes for streamId.

    • getWritesList

      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;

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

    • getWritesOrBuilderList

      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;

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

    • getStreamToken

      com.google.protobuf.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.v1.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:
      The streamToken.

    • getLabelsCount

      int getLabelsCount()
       Labels associated with this write request.
      map<string, string> labels = 5;

    • containsLabels

      boolean containsLabels(String key)
       Labels associated with this write request.
      map<string, string> labels = 5;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Labels associated with this write request.
      map<string, string> labels = 5;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Labels associated with this write request.
      map<string, string> labels = 5;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Labels associated with this write request.
      map<string, string> labels = 5;