Class: Google::Apis::AdminDirectoryV1::Role

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

JSON template for role resource in Directory API.

Defined Under Namespace

Classes: RolePrivilege

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Role

Returns a new instance of Role.



2536
2537
2538
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2536

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

Instance Attribute Details

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)


2497
2498
2499
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2497

def etag
  @etag
end

#is_super_admin_roleBoolean Also known as: is_super_admin_role?

Returns true if the role is a super admin role. Corresponds to the JSON property isSuperAdminRole

Returns:

  • (Boolean)


2502
2503
2504
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2502

def is_super_admin_role
  @is_super_admin_role
end

#is_system_roleBoolean Also known as: is_system_role?

Returns true if this is a pre-defined system role. Corresponds to the JSON property isSystemRole

Returns:

  • (Boolean)


2508
2509
2510
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2508

def is_system_role
  @is_system_role
end

#kindString

The type of the API resource. This is always admin#directory#role. Corresponds to the JSON property kind

Returns:

  • (String)


2514
2515
2516
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2514

def kind
  @kind
end

#role_descriptionString

A short description of the role. Corresponds to the JSON property roleDescription

Returns:

  • (String)


2519
2520
2521
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2519

def role_description
  @role_description
end

#role_idFixnum

ID of the role. Corresponds to the JSON property roleId

Returns:

  • (Fixnum)


2524
2525
2526
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2524

def role_id
  @role_id
end

#role_nameString

Name of the role. Corresponds to the JSON property roleName

Returns:

  • (String)


2529
2530
2531
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2529

def role_name
  @role_name
end

#role_privilegesArray<Google::Apis::AdminDirectoryV1::Role::RolePrivilege>

The set of privileges that are granted to this role. Corresponds to the JSON property rolePrivileges



2534
2535
2536
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2534

def role_privileges
  @role_privileges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 2541

def update!(**args)
  @etag = args[:etag] if args.key?(:etag)
  @is_super_admin_role = args[:is_super_admin_role] if args.key?(:is_super_admin_role)
  @is_system_role = args[:is_system_role] if args.key?(:is_system_role)
  @kind = args[:kind] if args.key?(:kind)
  @role_description = args[:role_description] if args.key?(:role_description)
  @role_id = args[:role_id] if args.key?(:role_id)
  @role_name = args[:role_name] if args.key?(:role_name)
  @role_privileges = args[:role_privileges] if args.key?(:role_privileges)
end