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



1077
1078
1079
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1077

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) 


1036
1037
1038
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1036

def deleted
  @deleted
end

#description ⇒ String

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

Returns:

  • (String) 


1042
1043
1044
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1042

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) 


1048
1049
1050
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1048

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


1053
1054
1055
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1053

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

Returns:

  • (String) 


1062
1063
1064
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1062

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) 


1069
1070
1071
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1069

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) 


1075
1076
1077
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1075

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1082
1083
1084
1085
1086
1087
1088
1089
1090
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1082

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