Class: Google::Apis::AdminDirectoryV1::Group

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

Overview

Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the Developer's Guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Group

Returns a new instance of Group.



1864
1865
1866
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1864

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

Instance Attribute Details

#admin_created ⇒ Boolean Also known as: admin_created?

Value is true if this group was created by an administrator rather than a user. Corresponds to the JSON property adminCreated

Returns:

  • (Boolean) 


1800
1801
1802
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1800

def admin_created
  @admin_created
end

#aliases ⇒ Array<String>

List of a group's alias email addresses. Corresponds to the JSON property aliases

Returns:

  • (Array<String>) 


1806
1807
1808
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1806

def aliases
  @aliases
end

#description ⇒ String

An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is 4,096 characters. Corresponds to the JSON property description

Returns:

  • (String) 


1814
1815
1816
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1814

def description
  @description
end

#direct_members_count ⇒ Fixnum

The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the directMembersCount property of the parent group. Corresponds to the JSON property directMembersCount

Returns:

  • (Fixnum) 


1821
1822
1823
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1821

def direct_members_count
  @direct_members_count
end

#email ⇒ String

The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The email must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the administration help center for the details. Corresponds to the JSON property email

Returns:

  • (String) 


1831
1832
1833
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1831

def email
  @email
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


1836
1837
1838
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1836

def etag
  @etag
end

#id ⇒ String

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

Returns:

  • (String) 


1842
1843
1844
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1842

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


1848
1849
1850
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1848

def kind
  @kind
end

#name ⇒ String

The group's display name. Corresponds to the JSON property name

Returns:

  • (String) 


1853
1854
1855
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1853

def name
  @name
end

#non_editable_aliases ⇒ Array<String>

List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. Corresponds to the JSON property nonEditableAliases

Returns:

  • (Array<String>) 


1862
1863
1864
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1862

def non_editable_aliases
  @non_editable_aliases
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
 
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1869

def update!(**args)
  @admin_created = args[:admin_created] if args.key?(:admin_created)
  @aliases = args[:aliases] if args.key?(:aliases)
  @description = args[:description] if args.key?(:description)
  @direct_members_count = args[:direct_members_count] if args.key?(:direct_members_count)
  @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)
  @name = args[:name] if args.key?(:name)
  @non_editable_aliases = args[:non_editable_aliases] if args.key?(:non_editable_aliases)
end