Class: Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1Workload

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

Overview

A Workload object for managing highly regulated workloads of cloud customers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAssuredworkloadsV1Workload

Returns a new instance of GoogleCloudAssuredworkloadsV1Workload.



2104
2105
2106
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2104

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

Instance Attribute Details

#billing_account ⇒ String

Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form billingAccounts/billing_account_id`. For example, billingAccounts/012345-567890-ABCDEF. Corresponds to the JSON propertybillingAccount`

Returns:

  • (String) 


1964
1965
1966
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 1964

def 
  @billing_account
end

#compliance_regime ⇒ String

Required. Immutable. Compliance Regime associated with this workload. Corresponds to the JSON property complianceRegime

Returns:

  • (String) 


1969
1970
1971
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 1969

def compliance_regime
  @compliance_regime
end

#compliance_status ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus

Represents the Compliance Status of this workload Corresponds to the JSON property complianceStatus

Returns:



1974
1975
1976
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 1974

def compliance_status
  @compliance_status
end

#compliant_but_disallowed_services ⇒ Array<String>

Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment. Corresponds to the JSON property compliantButDisallowedServices

Returns:

  • (Array<String>) 


1982
1983
1984
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 1982

def compliant_but_disallowed_services
  @compliant_but_disallowed_services
end

#create_time ⇒ String

Output only. Immutable. The Workload creation timestamp. Corresponds to the JSON property createTime

Returns:

  • (String) 


1987
1988
1989
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 1987

def create_time
  @create_time
end

#display_name ⇒ String

Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload Corresponds to the JSON property displayName

Returns:

  • (String) 


1994
1995
1996
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 1994

def display_name
  @display_name
end

#ekm_provisioning_response ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse

External key management systems(EKM) Provisioning response Corresponds to the JSON property ekmProvisioningResponse

Returns:



1999
2000
2001
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 1999

def ekm_provisioning_response
  @ekm_provisioning_response
end

#enable_sovereign_controls ⇒ Boolean Also known as: enable_sovereign_controls?

Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. Corresponds to the JSON property enableSovereignControls

Returns:

  • (Boolean) 


2005
2006
2007
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2005

def enable_sovereign_controls
  @enable_sovereign_controls
end

#etag ⇒ String

Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. Corresponds to the JSON property etag

Returns:

  • (String) 


2012
2013
2014
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2012

def etag
  @etag
end

#kaj_enrollment_state ⇒ String

Output only. Represents the KAJ enrollment state of the given workload. Corresponds to the JSON property kajEnrollmentState

Returns:

  • (String) 


2017
2018
2019
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2017

def kaj_enrollment_state
  @kaj_enrollment_state
end

#kms_settings ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1WorkloadKmsSettings

Settings specific to the Key Management Service. Corresponds to the JSON property kmsSettings

Returns:



2022
2023
2024
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2022

def kms_settings
  @kms_settings
end

#labels ⇒ Hash<String,String>

Optional. Labels applied to the workload. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2027
2028
2029
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2027

def labels
  @labels
end

#name ⇒ String

Optional. The resource name of the workload. Format: organizations/ organization/locations/location/workloads/workload Read-only. Corresponds to the JSON property name

Returns:

  • (String) 


2033
2034
2035
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2033

def name
  @name
end

#partner ⇒ String

Optional. Partner regime associated with this workload. Corresponds to the JSON property partner

Returns:

  • (String) 


2038
2039
2040
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2038

def partner
  @partner
end

#partner_permissions ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions

Permissions granted to the AW Partner SA account for the customer workload Corresponds to the JSON property partnerPermissions

Returns:



2043
2044
2045
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2043

def partner_permissions
  @partner_permissions
end

#partner_services_billing_account ⇒ String

Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC Corresponds to the JSON property partnerServicesBillingAccount

Returns:

  • (String) 


2052
2053
2054
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2052

def 
  @partner_services_billing_account
end

#provisioned_resources_parent ⇒ String

Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/folder_id Corresponds to the JSON property provisionedResourcesParent

Returns:

  • (String) 


2060
2061
2062
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2060

def provisioned_resources_parent
  @provisioned_resources_parent
end

#resource_monitoring_enabled ⇒ Boolean Also known as: resource_monitoring_enabled?

Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload. Corresponds to the JSON property resourceMonitoringEnabled

Returns:

  • (Boolean) 


2067
2068
2069
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2067

def resource_monitoring_enabled
  @resource_monitoring_enabled
end

#resource_settings ⇒ Array<Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1WorkloadResourceSettings>

Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. Corresponds to the JSON property resourceSettings

Returns:



2075
2076
2077
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2075

def resource_settings
  @resource_settings
end

#resources ⇒ Array<Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1WorkloadResourceInfo>

Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only. Corresponds to the JSON property resources

Returns:



2082
2083
2084
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2082

def resources
  @resources
end

#saa_enrollment_response ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse

Signed Access Approvals (SAA) enrollment response. Corresponds to the JSON property saaEnrollmentResponse

Returns:



2087
2088
2089
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2087

def saa_enrollment_response
  @saa_enrollment_response
end

#violation_notifications_enabled ⇒ Boolean Also known as: violation_notifications_enabled?

Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload. Corresponds to the JSON property violationNotificationsEnabled

Returns:

  • (Boolean) 


2096
2097
2098
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2096

def violation_notifications_enabled
  @violation_notifications_enabled
end

#workload_options ⇒ Google::Apis::AssuredworkloadsV1::GoogleCloudAssuredworkloadsV1WorkloadWorkloadOptions

Options to be set for the given created workload. Corresponds to the JSON property workloadOptions

Returns:



2102
2103
2104
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2102

def workload_options
  @workload_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
 
# File 'lib/google/apis/assuredworkloads_v1/classes.rb', line 2109

def update!(**args)
  @billing_account = args[:billing_account] if args.key?(:billing_account)
  @compliance_regime = args[:compliance_regime] if args.key?(:compliance_regime)
  @compliance_status = args[:compliance_status] if args.key?(:compliance_status)
  @compliant_but_disallowed_services = args[:compliant_but_disallowed_services] if args.key?(:compliant_but_disallowed_services)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @ekm_provisioning_response = args[:ekm_provisioning_response] if args.key?(:ekm_provisioning_response)
  @enable_sovereign_controls = args[:enable_sovereign_controls] if args.key?(:enable_sovereign_controls)
  @etag = args[:etag] if args.key?(:etag)
  @kaj_enrollment_state = args[:kaj_enrollment_state] if args.key?(:kaj_enrollment_state)
  @kms_settings = args[:kms_settings] if args.key?(:kms_settings)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @partner = args[:partner] if args.key?(:partner)
  @partner_permissions = args[:partner_permissions] if args.key?(:partner_permissions)
  @partner_services_billing_account = args[:partner_services_billing_account] if args.key?(:partner_services_billing_account)
  @provisioned_resources_parent = args[:provisioned_resources_parent] if args.key?(:provisioned_resources_parent)
  @resource_monitoring_enabled = args[:resource_monitoring_enabled] if args.key?(:resource_monitoring_enabled)
  @resource_settings = args[:resource_settings] if args.key?(:resource_settings)
  @resources = args[:resources] if args.key?(:resources)
  @saa_enrollment_response = args[:saa_enrollment_response] if args.key?(:saa_enrollment_response)
  @violation_notifications_enabled = args[:violation_notifications_enabled] if args.key?(:violation_notifications_enabled)
  @workload_options = args[:workload_options] if args.key?(:workload_options)
end