Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1QueryUserInfoRequest

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

Overview

Request message for QueryUserInfo.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1QueryUserInfoRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1QueryUserInfoRequest.



1541
1542
1543
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1541

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

Instance Attribute Details

#expression ⇒ Array<Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SqlExpression>

Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated. Corresponds to the JSON property expression

Returns:



1501
1502
1503
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1501

def expression
  @expression
end

#limit ⇒ Fixnum

The maximum number of accounts to return with an upper limit of 500. Defaults to 500. Only valid when return_user_info is set to true. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


1507
1508
1509
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1507

def limit
  @limit
end

#offset ⇒ Fixnum

The number of accounts to skip from the beginning of matching records. Only valid when return_user_info is set to true. Corresponds to the JSON property offset

Returns:

  • (Fixnum) 


1513
1514
1515
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1513

def offset
  @offset
end

#order ⇒ String

The order for sorting query result. Defaults to ascending order. Only valid when return_user_info is set to true. Corresponds to the JSON property order

Returns:

  • (String) 


1519
1520
1521
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1519

def order
  @order
end

#return_user_info ⇒ Boolean Also known as: return_user_info?

If true, this request will return the accounts matching the query. If false , only the count of accounts matching the query will be returned. Defaults to true. Corresponds to the JSON property returnUserInfo

Returns:

  • (Boolean) 


1526
1527
1528
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1526

def 
  @return_user_info
end

#sort_by ⇒ String

The field to use for sorting user accounts. Defaults to USER_ID. Note: when phone_number is specified in expression, the result ignores the sorting. Only valid when return_user_info is set to true. Corresponds to the JSON property sortBy

Returns:

  • (String) 


1534
1535
1536
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1534

def sort_by
  @sort_by
end

#tenant_id ⇒ String

The ID of the tenant to which the result is scoped. Corresponds to the JSON property tenantId

Returns:

  • (String) 


1539
1540
1541
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1539

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1546
1547
1548
1549
1550
1551
1552
1553
1554
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1546

def update!(**args)
  @expression = args[:expression] if args.key?(:expression)
  @limit = args[:limit] if args.key?(:limit)
  @offset = args[:offset] if args.key?(:offset)
  @order = args[:order] if args.key?(:order)
  @return_user_info = args[:return_user_info] if args.key?(:return_user_info)
  @sort_by = args[:sort_by] if args.key?(:sort_by)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end