Class: Google::Cloud::Firestore::V1::ListDocumentsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/firestore.rb

Overview

The request for Firestore.ListDocuments.

Instance Attribute Summary collapse

Instance Attribute Details

#collection_id ⇒ ::String

Returns Required. The collection ID, relative to parent, to list. For example: chatrooms or messages.

Returns:

  • (::String) —

    Required. The collection ID, relative to parent, to list. For example: chatrooms or messages.



91
92
93
94
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 91

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

#mask ⇒ ::Google::Cloud::Firestore::V1::DocumentMask

Returns The fields to return. If not set, returns all fields.

If a document has a field that is not present in this mask, that field will not be returned in the response.

Returns:



91
92
93
94
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 91

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

#order_by ⇒ ::String

Returns The order to sort results by. For example: priority desc, name.

Returns:

  • (::String) —

    The order to sort results by. For example: priority desc, name.



91
92
93
94
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 91

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

#page_size ⇒ ::Integer

Returns The maximum number of documents to return.

Returns:

  • (::Integer) —

    The maximum number of documents to return.



91
92
93
94
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 91

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

#page_token ⇒ ::String

Returns The next_page_token value returned from a previous List request, if any.

Returns:

  • (::String) —

    The next_page_token value returned from a previous List request, if any.



91
92
93
94
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 91

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

#parent ⇒ ::String

Returns Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom.

Returns:

  • (::String) —

    Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom



91
92
93
94
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 91

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

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

Returns Reads documents as they were at the given time. This may not be older than 270 seconds.

Returns:



91
92
93
94
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 91

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

#show_missing ⇒ ::Boolean

Returns If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set.

Requests with show_missing may not specify where or order_by.

Returns:

  • (::Boolean) —

    If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set.

    Requests with show_missing may not specify where or order_by.



91
92
93
94
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 91

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

#transaction ⇒ ::String

Returns Reads documents in a transaction.

Returns:

  • (::String) —

    Reads documents in a transaction.



91
92
93
94
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 91

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