Class: Google::Cloud::Firestore::V1::BatchGetDocumentsResponse

Inherits:

Object

• Object
• Google::Cloud::Firestore::V1::BatchGetDocumentsResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/firestore/v1/firestore.rb

Overview

The streamed response for Firestore.BatchGetDocuments.

Instance Attribute Summary

• #found ⇒ ::Google::Cloud::Firestore::V1::Document

  A document that was requested.

• #missing ⇒ ::String

  A document name that was requested but does not exist.

• #read_time ⇒ ::Google::Protobuf::Timestamp

  The time at which the document was read.

• #transaction ⇒ ::String

  The transaction that was started as part of this request.

Instance Attribute Details

#found ⇒ ::Google::Cloud::Firestore::V1::Document

Returns A document that was requested.

Returns:

• (::Google::Cloud::Firestore::V1::Document) —

  A document that was requested.

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

class BatchGetDocumentsResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#missing ⇒ ::String

Returns A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Returns:

• (::String) —

  A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

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

class BatchGetDocumentsResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_time ⇒ ::Google::Protobuf::Timestamp

Returns The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

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

class BatchGetDocumentsResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transaction ⇒ ::String

Returns The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

Returns:

• (::String) —

  The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

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

class BatchGetDocumentsResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end