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.


1856
1857
1858
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1856

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

Instance Attribute Details

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)

1817
1818
1819
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1817

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)

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

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)

1828
1829
1830
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1828

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)

1834
1835
1836
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1834

def kind
  @kind
end

#role_descriptionString

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

Returns:

  • (String)

1839
1840
1841
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1839

def role_description
  @role_description
end

#role_idString

ID of the role. Corresponds to the JSON property roleId

Returns:

  • (String)

1844
1845
1846
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1844

def role_id
  @role_id
end

#role_nameString

Name of the role. Corresponds to the JSON property roleName

Returns:

  • (String)

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

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


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

def role_privileges
  @role_privileges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 1861

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