Class: Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1Workload

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/assuredworkloads_v1beta1/classes.rb,
lib/google/apis/assuredworkloads_v1beta1/representations.rb,
lib/google/apis/assuredworkloads_v1beta1/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) ⇒ GoogleCloudAssuredworkloadsV1beta1Workload

Returns a new instance of GoogleCloudAssuredworkloadsV1beta1Workload.



632
633
634
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 632

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) 


494
495
496
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 494

def 
  @billing_account
end

#cjis_settings ⇒ Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadCjisSettings

Settings specific to resources needed for CJIS. Corresponds to the JSON property cjisSettings

Returns:



499
500
501
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 499

def cjis_settings
  @cjis_settings
end

#compliance_regime ⇒ String

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

Returns:

  • (String) 


504
505
506
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 504

def compliance_regime
  @compliance_regime
end

#compliance_status ⇒ Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadComplianceStatus

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

Returns:



509
510
511
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 509

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


517
518
519
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 517

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) 


522
523
524
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 522

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) 


529
530
531
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 529

def display_name
  @display_name
end

#ekm_provisioning_response ⇒ Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadEkmProvisioningResponse

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

Returns:



534
535
536
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 534

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) 


540
541
542
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 540

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) 


547
548
549
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 547

def etag
  @etag
end

#fedramp_high_settings ⇒ Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings

Settings specific to resources needed for FedRAMP High. Corresponds to the JSON property fedrampHighSettings

Returns:



552
553
554
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 552

def fedramp_high_settings
  @fedramp_high_settings
end

#fedramp_moderate_settings ⇒ Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings

Settings specific to resources needed for FedRAMP Moderate. Corresponds to the JSON property fedrampModerateSettings

Returns:



557
558
559
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 557

def fedramp_moderate_settings
  @fedramp_moderate_settings
end

#il4_settings ⇒ Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadIl4Settings

Settings specific to resources needed for IL4. Corresponds to the JSON property il4Settings

Returns:



562
563
564
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 562

def il4_settings
  @il4_settings
end

#kaj_enrollment_state ⇒ String

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

Returns:

  • (String) 


567
568
569
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 567

def kaj_enrollment_state
  @kaj_enrollment_state
end

#kms_settings ⇒ Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadKmsSettings

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

Returns:



572
573
574
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 572

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


577
578
579
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 577

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) 


583
584
585
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 583

def name
  @name
end

#partner ⇒ String

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

Returns:

  • (String) 


588
589
590
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 588

def partner
  @partner
end

#partner_permissions ⇒ Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadPartnerPermissions

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

Returns:



593
594
595
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 593

def partner_permissions
  @partner_permissions
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) 


601
602
603
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 601

def provisioned_resources_parent
  @provisioned_resources_parent
end

#resource_settings ⇒ Array<Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings>

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:



608
609
610
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 608

def resource_settings
  @resource_settings
end

#resources ⇒ Array<Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo>

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:



615
616
617
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 615

def resources
  @resources
end

#saa_enrollment_response ⇒ Google::Apis::AssuredworkloadsV1beta1::GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse

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

Returns:



620
621
622
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 620

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) 


629
630
631
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 629

def violation_notifications_enabled
  @violation_notifications_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/google/apis/assuredworkloads_v1beta1/classes.rb', line 637

def update!(**args)
  @billing_account = args[:billing_account] if args.key?(:billing_account)
  @cjis_settings = args[:cjis_settings] if args.key?(:cjis_settings)
  @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)
  @fedramp_high_settings = args[:fedramp_high_settings] if args.key?(:fedramp_high_settings)
  @fedramp_moderate_settings = args[:fedramp_moderate_settings] if args.key?(:fedramp_moderate_settings)
  @il4_settings = args[:il4_settings] if args.key?(:il4_settings)
  @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)
  @provisioned_resources_parent = args[:provisioned_resources_parent] if args.key?(:provisioned_resources_parent)
  @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)
end