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.



2884
2885
2886
# File 'lib/google/apis/firestore_v1/classes.rb', line 2884

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

Instance Attribute Details

#page_sizeFixnum

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

Returns:

  • (Fixnum)


2870
2871
2872
# File 'lib/google/apis/firestore_v1/classes.rb', line 2870

def page_size
  @page_size
end

#page_tokenString

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

Returns:

  • (String)


2875
2876
2877
# File 'lib/google/apis/firestore_v1/classes.rb', line 2875

def page_token
  @page_token
end

#read_timeString

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)


2882
2883
2884
# File 'lib/google/apis/firestore_v1/classes.rb', line 2882

def read_time
  @read_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2889
2890
2891
2892
2893
# File 'lib/google/apis/firestore_v1/classes.rb', line 2889

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)
end