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

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

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.



2270
2271
2272
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2270

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

Instance Attribute Details

#admin_created ⇒ Boolean Also known as: admin_created?

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

Returns:

  • (Boolean) 


2205
2206
2207
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2205

def admin_created
  @admin_created
end

#aliases ⇒ Array<String>

Read-only. A list of a group's alias email addresses. To add, update, or remove a group's aliases, use the groups.aliases methods. If edited in a group's POST or PUT request, the edit is ignored. Corresponds to the JSON property aliases

Returns:

  • (Array<String>) 


2213
2214
2215
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2213

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) 


2221
2222
2223
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2221

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) 


2228
2229
2230
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2228

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 help center for details. Corresponds to the JSON property email

Returns:

  • (String) 


2237
2238
2239
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2237

def email
  @email
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2242
2243
2244
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2242

def etag
  @etag
end

#id ⇒ String

Read-only. 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) 


2248
2249
2250
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2248

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) 


2254
2255
2256
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2254

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


2259
2260
2261
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2259

def name
  @name
end

#non_editable_aliases ⇒ Array<String>

Read-only. A 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. Corresponds to the JSON property nonEditableAliases

Returns:

  • (Array<String>) 


2268
2269
2270
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2268

def non_editable_aliases
  @non_editable_aliases
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2275

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