Class: Google::Cloud::Firestore::V1::WriteRequest

Inherits:

Object

• Object
• Google::Cloud::Firestore::V1::WriteRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/firestore/v1/firestore.rb

Overview

The request for Firestore.Write.

The first request creates a stream, or resumes an existing one from a token.

When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request.

When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary

• #database ⇒ ::String

  Required.

• #labels ⇒ ::Google::Protobuf::Map{::String => ::String}

  Labels associated with this write request.

• #stream_id ⇒ ::String

  The ID of the write stream to resume.

• #stream_token ⇒ ::String

  A stream token that was previously sent by the server.

• #writes ⇒ ::Array<::Google::Cloud::Firestore::V1::Write>

  The writes to apply.

Instance Attribute Details

#database ⇒ ::String

# File 'proto_docs/google/firestore/v1/firestore.rb', line 496

class WriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

# File 'proto_docs/google/firestore/v1/firestore.rb', line 496

class WriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#stream_id ⇒ ::String

# File 'proto_docs/google/firestore/v1/firestore.rb', line 496

class WriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#stream_token ⇒ ::String

# File 'proto_docs/google/firestore/v1/firestore.rb', line 496

class WriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#writes ⇒ ::Array<::Google::Cloud::Firestore::V1::Write>

# File 'proto_docs/google/firestore/v1/firestore.rb', line 496

class WriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end