Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::ListCollectionIdsRequest.
The request for Firestore.ListCollectionIds.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#page_size
def page_size() -> ::Integer
Returns
- (::Integer) — The maximum number of results to return.
#page_size=
def page_size=(value) -> ::Integer
Parameter
- value (::Integer) — The maximum number of results to return.
Returns
- (::Integer) — The maximum number of results to return.
#page_token
def page_token() -> ::String
Returns
- (::String) — A page token. Must be a value from ListCollectionIdsResponse.
#page_token=
def page_token=(value) -> ::String
Parameter
- value (::String) — A page token. Must be a value from ListCollectionIdsResponse.
Returns
- (::String) — A page token. Must be a value from ListCollectionIdsResponse.
#parent
def parent() -> ::String
Returns
-
(::String) — Required. The parent document. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — Required. The parent document. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
Returns
-
(::String) — Required. The parent document. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
#read_time
def read_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Reads documents as they were at the given time. This may not be older than 270 seconds.
#read_time=
def read_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Reads documents as they were at the given time. This may not be older than 270 seconds.
Returns
- (::Google::Protobuf::Timestamp) — Reads documents as they were at the given time. This may not be older than 270 seconds.