Class: Google::Apis::CloudidentityV1::UserInvitation

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

Overview

The UserInvitation resource represents an email that can be sent to an unmanaged user account inviting them to join the customer's Google Workspace or Cloud Identity account. An unmanaged account shares an email address domain with the Google Workspace or Cloud Identity account but is not managed by it yet. If the user accepts the UserInvitation, the user account will become managed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UserInvitation

Returns a new instance of UserInvitation.



3567
3568
3569
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 3567

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

Instance Attribute Details

#mails_sent_count ⇒ Fixnum

Number of invitation emails sent to the user. Corresponds to the JSON property mailsSentCount

Returns:

  • (Fixnum) 


3549
3550
3551
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 3549

def mails_sent_count
  @mails_sent_count
end

#name ⇒ String

Shall be of the form customers/customer/userinvitations/user_email_address . Corresponds to the JSON property name

Returns:

  • (String) 


3555
3556
3557
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 3555

def name
  @name
end

#state ⇒ String

State of the UserInvitation. Corresponds to the JSON property state

Returns:

  • (String) 


3560
3561
3562
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 3560

def state
  @state
end

#update_time ⇒ String

Time when the UserInvitation was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


3565
3566
3567
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 3565

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3572
3573
3574
3575
3576
3577
 
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 3572

def update!(**args)
  @mails_sent_count = args[:mails_sent_count] if args.key?(:mails_sent_count)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end