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

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

Overview

A role in the Identity and Access Management API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Role

Returns a new instance of Role.



2170
2171
2172
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2170

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

Returns:

  • (Boolean) 


2128
2129
2130
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2128

def deleted
  @deleted
end

#description ⇒ String

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

Returns:

  • (String) 


2134
2135
2136
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2134

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.

Returns:

  • (String) 


2140
2141
2142
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2140

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

Returns:

  • (Array<String>) 


2145
2146
2147
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2145

def included_permissions
  @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. For example, roles/logging.viewer for predefined roles, organizations/ORGANIZATION_ID/roles/myRole for organization-level custom roles, and projects/PROJECT_ID/roles/myRole for project-level custom roles. Corresponds to the JSON property name

Returns:

  • (String) 


2155
2156
2157
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2155

def name
  @name
end

#stage ⇒ String

The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role. Corresponds to the JSON property stage

Returns:

  • (String) 


2162
2163
2164
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2162

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

Returns:

  • (String) 


2168
2169
2170
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2168

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2175
2176
2177
2178
2179
2180
2181
2182
2183
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2175

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