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



143
144
145
 
# File 'generated/google/apis/iam_v1/classes.rb', line 143

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) 


141
142
143
 
# File 'generated/google/apis/iam_v1/classes.rb', line 141

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) 


136
137
138
 
# File 'generated/google/apis/iam_v1/classes.rb', line 136

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) 


127
128
129
 
# File 'generated/google/apis/iam_v1/classes.rb', line 127

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



148
149
150
151
152
 
# File 'generated/google/apis/iam_v1/classes.rb', line 148

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