Class: Google::Apis::IamV1::Role

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

Overview

A role in the Identity and Access Management API.

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



240
241
242
 
# File 'generated/google/apis/iam_v1/classes.rb', line 240

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

Instance Attribute Details

#description ⇒ String

Optional. A human-readable description for the role. Corresponds to the JSON property description

Returns:

  • (String) 


238
239
240
 
# File 'generated/google/apis/iam_v1/classes.rb', line 238

def description
  @description
end

#name ⇒ String

The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for curated roles and organizations/ORGANIZATION_ID/roles/logging.viewer for custom roles. Corresponds to the JSON property name

Returns:

  • (String) 


233
234
235
 
# File 'generated/google/apis/iam_v1/classes.rb', line 233

def name
  @name
end

#title ⇒ String

Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes. Corresponds to the JSON property title

Returns:

  • (String) 


224
225
226
 
# File 'generated/google/apis/iam_v1/classes.rb', line 224

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



245
246
247
248
249
 
# File 'generated/google/apis/iam_v1/classes.rb', line 245

def update!(**args)
  @title = args[:title] if args.key?(:title)
  @name = args[:name] if args.key?(:name)
  @description = args[:description] if args.key?(:description)
end