Class Workload (1.12.3)

Workload(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof:


name str
Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
display_name str
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
resources MutableSequence[]
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.
Required. Immutable. Compliance Regime associated with this workload.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Immutable. The Workload creation timestamp.
billing_account str
Output only. 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.
Input only. Immutable. Settings specific to resources needed for IL4. This field is a member of oneof_ compliance_regime_settings.
Input only. Immutable. Settings specific to resources needed for CJIS. This field is a member of oneof_ compliance_regime_settings.
Input only. Immutable. Settings specific to resources needed for FedRAMP High. This field is a member of oneof_ compliance_regime_settings.
Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate. This field is a member of oneof_ compliance_regime_settings.
etag str
Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
labels MutableMapping[str, str]
Optional. Labels applied to the workload.
provisioned_resources_parent str
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}
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.
resource_settings MutableSequence[]
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.
Output only. Represents the KAJ enrollment state of the given workload.
enable_sovereign_controls bool
Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.
compliant_but_disallowed_services MutableSequence[str]
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.".



CJISSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings specific to resources needed for CJIS.



Supported Compliance Regimes.

Values: COMPLIANCE_REGIME_UNSPECIFIED (0): Unknown compliance regime. IL4 (1): Information protection as per DoD IL4 requirements. CJIS (2): Criminal Justice Information Services (CJIS) Security policies. FEDRAMP_HIGH (3): FedRAMP High data protection controls FEDRAMP_MODERATE (4): FedRAMP Moderate data protection controls US_REGIONAL_ACCESS (5): Assured Workloads For US Regions data protection controls HIPAA (6): Health Insurance Portability and Accountability Act controls HITRUST (7): Health Information Trust Alliance controls EU_REGIONS_AND_SUPPORT (8): Assured Workloads For EU Regions and Support controls CA_REGIONS_AND_SUPPORT (9): Assured Workloads For Canada Regions and Support controls ITAR (10): International Traffic in Arms Regulations AU_REGIONS_AND_US_SUPPORT (11): Assured Workloads for Australia Regions and Support controls


FedrampHighSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings specific to resources needed for FedRAMP High.


FedrampModerateSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings specific to resources needed for FedRAMP Moderate.


IL4Settings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings specific to resources needed for IL4.


KMSSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Settings specific to the Key Management Service.



Key Access Justifications(KAJ) Enrollment State.

Values: KAJ_ENROLLMENT_STATE_UNSPECIFIED (0): Default State for KAJ Enrollment. KAJ_ENROLLMENT_STATE_PENDING (1): Pending State for KAJ Enrollment. KAJ_ENROLLMENT_STATE_COMPLETE (2): Complete State for KAJ Enrollment.


LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.


ResourceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represent the resources that are children of this Workload.


ResourceSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represent the custom settings for the resources to be created.


SaaEnrollmentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)