Class: Google::Apis::AccessapprovalV1::AccessApprovalSettings

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

Overview

Settings on a Project/Folder/Organization related to Access Approval.

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

Returns a new instance of AccessApprovalSettings.


67
68
69
# File 'generated/google/apis/accessapproval_v1/classes.rb', line 67

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#enrolled_ancestorBoolean Also known as: enrolled_ancestor?

Output only. This field is read only (not settable via UpdateAccessAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). Corresponds to the JSON property enrolledAncestor

Returns:

  • (Boolean)

36
37
38
# File 'generated/google/apis/accessapproval_v1/classes.rb', line 36

def enrolled_ancestor
  @enrolled_ancestor
end

#enrolled_servicesArray<Google::Apis::AccessapprovalV1::EnrolledService>

A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. Corresponds to the JSON property enrolledServices


50
51
52
# File 'generated/google/apis/accessapproval_v1/classes.rb', line 50

def enrolled_services
  @enrolled_services
end

#nameString

The resource name of the settings. Format is one of: 1. "projects/project_id/ accessApprovalSettings" 2. "folders/folder_id/accessApprovalSettings" 3. " organizations/organization_id/accessApprovalSettings" Corresponds to the JSON property name

Returns:

  • (String)

57
58
59
# File 'generated/google/apis/accessapproval_v1/classes.rb', line 57

def name
  @name
end

#notification_emailsArray<String>

A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. Corresponds to the JSON property notificationEmails

Returns:

  • (Array<String>)

65
66
67
# File 'generated/google/apis/accessapproval_v1/classes.rb', line 65

def notification_emails
  @notification_emails
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


72
73
74
75
76
77
# File 'generated/google/apis/accessapproval_v1/classes.rb', line 72

def update!(**args)
  @enrolled_ancestor = args[:enrolled_ancestor] if args.key?(:enrolled_ancestor)
  @enrolled_services = args[:enrolled_services] if args.key?(:enrolled_services)
  @name = args[:name] if args.key?(:name)
  @notification_emails = args[:notification_emails] if args.key?(:notification_emails)
end