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.



554
555
556
 
# File 'generated/google/apis/iam_v1/classes.rb', line 554

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) 


552
553
554
 
# File 'generated/google/apis/iam_v1/classes.rb', line 552

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) 


541
542
543
 
# File 'generated/google/apis/iam_v1/classes.rb', line 541

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) 


547
548
549
 
# File 'generated/google/apis/iam_v1/classes.rb', line 547

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



559
560
561
562
563
 
# File 'generated/google/apis/iam_v1/classes.rb', line 559

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