Class: Google::Apis::FirestoreV1::ListCollectionIdsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

The request for Firestore.ListCollectionIds.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ListCollectionIdsRequest

Returns a new instance of ListCollectionIdsRequest.



3775
3776
3777
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3775

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#page_size ⇒ Fixnum

The maximum number of results to return. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


3756
3757
3758
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3756

def page_size
  @page_size
end

#page_token ⇒ String

A page token. Must be a value from ListCollectionIdsResponse. Corresponds to the JSON property pageToken

Returns:

  • (String) 


3761
3762
3763
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3761

def page_token
  @page_token
end

#read_time ⇒ String

Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. Corresponds to the JSON property readTime

Returns:

  • (String) 


3768
3769
3770
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3768

def read_time
  @read_time
end

#request_options ⇒ Google::Apis::FirestoreV1::RequestOptions

Options for a server request. Corresponds to the JSON property requestOptions

Returns:



3773
3774
3775
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3773

def request_options
  @request_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3780
3781
3782
3783
3784
3785
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3780

def update!(**args)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @read_time = args[:read_time] if args.key?(:read_time)
  @request_options = args[:request_options] if args.key?(:request_options)
end