Class: Google::Apis::AdminDirectoryV1::Member

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

Overview

A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the Developer's Guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Member

Returns a new instance of Member.



2659
2660
2661
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2659

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

Instance Attribute Details

#delivery_settings ⇒ String

Defines mail delivery preferences of member. This field is only supported by insert, update, and get methods. Corresponds to the JSON property delivery_settings

Returns:

  • (String) 


2614
2615
2616
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2614

def delivery_settings
  @delivery_settings
end

#email ⇒ String

The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. Corresponds to the JSON property email

Returns:

  • (String) 


2622
2623
2624
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2622

def email
  @email
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2627
2628
2629
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2627

def etag
  @etag
end

#id ⇒ String

The unique ID of the group member. A member id can be used as a member request URI's memberKey. Corresponds to the JSON property id

Returns:

  • (String) 


2633
2634
2635
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2633

def id
  @id
end

#kind ⇒ String

The type of the API resource. For Members resources, the value is admin# directory#member. Corresponds to the JSON property kind

Returns:

  • (String) 


2639
2640
2641
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2639

def kind
  @kind
end

#role ⇒ String

The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. For more information about a member's role, see the administration help center. Corresponds to the JSON property role

Returns:

  • (String) 


2647
2648
2649
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2647

def role
  @role
end

#status ⇒ String

Status of member (Immutable) Corresponds to the JSON property status

Returns:

  • (String) 


2652
2653
2654
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2652

def status
  @status
end

#type ⇒ String

The type of group member. Corresponds to the JSON property type

Returns:

  • (String) 


2657
2658
2659
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2657

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2664

def update!(**args)
  @delivery_settings = args[:delivery_settings] if args.key?(:delivery_settings)
  @email = args[:email] if args.key?(:email)
  @etag = args[:etag] if args.key?(:etag)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @role = args[:role] if args.key?(:role)
  @status = args[:status] if args.key?(:status)
  @type = args[:type] if args.key?(:type)
end