Class: Google::Apis::IamV1::Role
- Inherits:
-
Object
- Object
- Google::Apis::IamV1::Role
- 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
-
#deleted ⇒ Boolean
(also: #deleted?)
The current deleted state of the role.
-
#description ⇒ String
Optional.
-
#etag ⇒ String
Used to perform a consistent read-modify-write.
-
#included_permissions ⇒ Array<String>
The names of the permissions this role grants when bound in an IAM policy.
-
#name ⇒ String
The name of the role.
-
#stage ⇒ String
The current launch stage of the role.
-
#title ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Role
constructor
A new instance of Role.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Role
Returns a new instance of Role
821 822 823 |
# File 'generated/google/apis/iam_v1/classes.rb', line 821 def initialize(**args) update!(**args) end |
Instance Attribute Details
#deleted ⇒ Boolean Also known as: deleted?
The current deleted state of the role. This field is read only.
It will be ignored in calls to CreateRole and UpdateRole.
Corresponds to the JSON property deleted
782 783 784 |
# File 'generated/google/apis/iam_v1/classes.rb', line 782 def deleted @deleted end |
#description ⇒ String
Optional. A human-readable description for the role.
Corresponds to the JSON property description
788 789 790 |
# File 'generated/google/apis/iam_v1/classes.rb', line 788 def description @description end |
#etag ⇒ String
Used to perform a consistent read-modify-write.
Corresponds to the JSON property etag
NOTE: Values are automatically base64 encoded/decoded in the client library.
794 795 796 |
# File 'generated/google/apis/iam_v1/classes.rb', line 794 def etag @etag end |
#included_permissions ⇒ Array<String>
The names of the permissions this role grants when bound in an IAM policy.
Corresponds to the JSON property includedPermissions
799 800 801 |
# File 'generated/google/apis/iam_v1/classes.rb', line 799 def @included_permissions 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
808 809 810 |
# File 'generated/google/apis/iam_v1/classes.rb', line 808 def name @name end |
#stage ⇒ String
The current launch stage of the role.
Corresponds to the JSON property stage
813 814 815 |
# File 'generated/google/apis/iam_v1/classes.rb', line 813 def stage @stage 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
819 820 821 |
# File 'generated/google/apis/iam_v1/classes.rb', line 819 def title @title end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
826 827 828 829 830 831 832 833 834 |
# File 'generated/google/apis/iam_v1/classes.rb', line 826 def update!(**args) @deleted = args[:deleted] if args.key?(:deleted) @description = args[:description] if args.key?(:description) @etag = args[:etag] if args.key?(:etag) @included_permissions = args[:included_permissions] if args.key?(:included_permissions) @name = args[:name] if args.key?(:name) @stage = args[:stage] if args.key?(:stage) @title = args[:title] if args.key?(:title) end |