WorkloadArgs class
The set of arguments for Workload. The set of arguments for Workload.
Constructors
-
WorkloadArgs({Input<
String> ? billingAccount, required Input<WorkloadComplianceRegime> complianceRegime, required Input<String> displayName, Input<bool> ? enableSovereignControls, Input<String> ? etag, Input<String> ? externalId, Input<GoogleCloudAssuredworkloadsV1WorkloadKMSSettings> ? kmsSettings, Input<Map< ? labels, Input<String, String> >String> ? location, Input<String> ? name, required Input<String> organizationId, Input<WorkloadPartner> ? partner, Input<GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions> ? partnerPermissions, Input<String> ? provisionedResourcesParent, Input<List< ? resourceSettings, Input<GoogleCloudAssuredworkloadsV1WorkloadResourceSettings> >bool> ? violationNotificationsEnabled}) -
Creates a new WorkloadArgs.
billingAccountOptional. 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 formbillingAccounts/{billing_account_id}. For example,billingAccounts/012345-567890-ABCDEF.complianceRegimeImmutable. Compliance Regime associated with this workload.displayNameThe 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 WorkloadenableSovereignControlsOptional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.etagOptional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.externalIdOptional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.kmsSettingsInput only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.labelsOptional. Labels applied to the workload.locationOptional.nameOptional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.organizationIdRequired.partnerOptional. Partner regime associated with this workload.partnerPermissionsOptional. Permissions granted to the AW Partner SA account for the customer workloadprovisionedResourcesParentInput 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}resourceSettingsInput 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.violationNotificationsEnabledOptional. 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.const -
WorkloadArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
billingAccount
→ Input<
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.final -
complianceRegime
→ Input<
WorkloadComplianceRegime> -
Immutable. Compliance Regime associated with this workload.
final
-
displayName
→ Input<
String> -
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
final
-
enableSovereignControls
→ Input<
bool> ? -
Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
final
-
etag
→ Input<
String> ? -
Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
final
-
externalId
→ Input<
String> ? -
Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
kmsSettings
→ Input<
GoogleCloudAssuredworkloadsV1WorkloadKMSSettings> ? -
Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.
final
-
labels
→ Input<
Map< ?String, String> > -
Optional. Labels applied to the workload.
final
-
location
→ Input<
String> ? -
final
-
name
→ Input<
String> ? -
Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
final
-
organizationId
→ Input<
String> -
final
-
partner
→ Input<
WorkloadPartner> ? -
Optional. Partner regime associated with this workload.
final
-
partnerPermissions
→ Input<
GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions> ? -
Optional. Permissions granted to the AW Partner SA account for the customer workload
final
-
provisionedResourcesParent
→ Input<
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}
final
-
resourceSettings
→ Input<
List< ?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.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
violationNotificationsEnabled
→ Input<
bool> ? -
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.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited