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.



1313
1314
1315
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1313

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) 


1272
1273
1274
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1272

def deleted
  @deleted
end

#description ⇒ String

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

Returns:

  • (String) 


1278
1279
1280
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1278

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) 


1284
1285
1286
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1284

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>) 


1289
1290
1291
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1289

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, e.g., roles/logging.viewer for predefined roles and organizations/ORGANIZATION_ID/roles/logging.viewer for custom roles. Corresponds to the JSON property name

Returns:

  • (String) 


1298
1299
1300
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1298

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) 


1305
1306
1307
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1305

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) 


1311
1312
1313
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1311

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1318
1319
1320
1321
1322
1323
1324
1325
1326
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1318

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