Class Workload (1.4.2)

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: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
`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`	`Sequence[google.cloud.assuredworkloads_v1beta1.types.Workload.ResourceInfo]` 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.
`compliance_regime`	`google.cloud.assuredworkloads_v1beta1.types.Workload.ComplianceRegime` 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`.
`il4_settings`	`google.cloud.assuredworkloads_v1beta1.types.Workload.IL4Settings` Input only. Immutable. Settings specific to resources needed for IL4. This field is a member of `oneof`_ `compliance_regime_settings`.
`cjis_settings`	`google.cloud.assuredworkloads_v1beta1.types.Workload.CJISSettings` Input only. Immutable. Settings specific to resources needed for CJIS. This field is a member of `oneof`_ `compliance_regime_settings`.
`fedramp_high_settings`	`google.cloud.assuredworkloads_v1beta1.types.Workload.FedrampHighSettings` Input only. Immutable. Settings specific to resources needed for FedRAMP High. This field is a member of `oneof`_ `compliance_regime_settings`.
`fedramp_moderate_settings`	`google.cloud.assuredworkloads_v1beta1.types.Workload.FedrampModerateSettings` 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`	`Mapping[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}
`kms_settings`	`google.cloud.assuredworkloads_v1beta1.types.Workload.KMSSettings` 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`	`Sequence[google.cloud.assuredworkloads_v1beta1.types.Workload.ResourceSettings]` 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.
`kaj_enrollment_state`	`google.cloud.assuredworkloads_v1beta1.types.Workload.KajEnrollmentState` 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.
`saa_enrollment_response`	`google.cloud.assuredworkloads_v1beta1.types.Workload.SaaEnrollmentResponse` 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.

Classes

CJISSettings

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

Settings specific to resources needed for CJIS.

ComplianceRegime

ComplianceRegime(value)

Supported Compliance Regimes.

FedrampHighSettings

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

Settings specific to resources needed for FedRAMP High.

FedrampModerateSettings

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

Settings specific to resources needed for FedRAMP Moderate.

IL4Settings

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

Settings specific to resources needed for IL4.

KMSSettings

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

Settings specific to the Key Management Service.

KajEnrollmentState

KajEnrollmentState(value)

Key Access Justifications(KAJ) Enrollment State.

LabelsEntry

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

The abstract base class for a message.

Parameters

Name	Description
`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

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

Represent the resources that are children of this Workload.

ResourceSettings

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

Represent the custom settings for the resources to be created.

SaaEnrollmentResponse

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

Signed Access Approvals (SAA) enrollment response.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields