Reference documentation and code samples for the Google Cloud Assured Workloads V1beta1 Client class Workload.
An Workload object for managing highly regulated workloads of cloud customers.
Generated from protobuf message google.cloud.assuredworkloads.v1beta1.Workload
Namespace
Google \ Cloud \ AssuredWorkloads \ V1beta1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
↳ 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
↳ resources
array< 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
int
Required. Immutable. Compliance Regime associated with this workload.
↳ create_time
↳ billing_account
string
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
Workload\IL4Settings
Input only. Immutable. Settings specific to resources needed for IL4.
↳ cjis_settings
Workload\CJISSettings
Input only. Immutable. Settings specific to resources needed for CJIS.
↳ fedramp_high_settings
Workload\FedrampHighSettings
Input only. Immutable. Settings specific to resources needed for FedRAMP High.
↳ fedramp_moderate_settings
Workload\FedrampModerateSettings
Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
↳ 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.
↳ labels
↳ 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}
↳ kms_settings
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
array< 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
int
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
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.
↳ compliant_but_disallowed_services
array
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."
getName
Optional. The resource name of the workload.
Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
string
setName
Optional. The resource name of the workload.
Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
var
string
$this
getDisplayName
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
string
setDisplayName
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
var
string
$this
getResources
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.
setResources
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.
$this
getComplianceRegime
Required. Immutable. Compliance Regime associated with this workload.
int
setComplianceRegime
Required. Immutable. Compliance Regime associated with this workload.
var
int
$this
getCreateTime
Output only. Immutable. The Workload creation timestamp.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Immutable. The Workload creation timestamp.
$this
getBillingAccount
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
.
string
setBillingAccount
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
.
var
string
$this
getIl4Settings
Input only. Immutable. Settings specific to resources needed for IL4.
Workload\IL4Settings
|null
hasIl4Settings
setIl4Settings
Input only. Immutable. Settings specific to resources needed for IL4.
var
Workload\IL4Settings
$this
getCjisSettings
Input only. Immutable. Settings specific to resources needed for CJIS.
Workload\CJISSettings
|null
hasCjisSettings
setCjisSettings
Input only. Immutable. Settings specific to resources needed for CJIS.
var
Workload\CJISSettings
$this
getFedrampHighSettings
Input only. Immutable. Settings specific to resources needed for FedRAMP High.
Workload\FedrampHighSettings
|null
hasFedrampHighSettings
setFedrampHighSettings
Input only. Immutable. Settings specific to resources needed for FedRAMP High.
var
Workload\FedrampHighSettings
$this
getFedrampModerateSettings
Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
Workload\FedrampModerateSettings
|null
hasFedrampModerateSettings
setFedrampModerateSettings
Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
var
Workload\FedrampModerateSettings
$this
getEtag
Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
string
setEtag
Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
var
string
$this
getLabels
Optional. Labels applied to the workload.
setLabels
Optional. Labels applied to the workload.
$this
getProvisionedResourcesParent
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}
string
setProvisionedResourcesParent
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}
var
string
$this
getKmsSettings
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.
Workload\KMSSettings
|null
hasKmsSettings
clearKmsSettings
setKmsSettings
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.
var
Workload\KMSSettings
$this
getResourceSettings
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.
setResourceSettings
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.
$this
getKajEnrollmentState
Output only. Represents the KAJ enrollment state of the given workload.
int
setKajEnrollmentState
Output only. Represents the KAJ enrollment state of the given workload.
var
int
$this
getEnableSovereignControls
Optional. Indicates the sovereignty status of the given workload.
Currently meant to be used by Europe/Canada customers.
bool
setEnableSovereignControls
Optional. Indicates the sovereignty status of the given workload.
Currently meant to be used by Europe/Canada customers.
var
bool
$this
getSaaEnrollmentResponse
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.
hasSaaEnrollmentResponse
clearSaaEnrollmentResponse
setSaaEnrollmentResponse
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.
$this
getCompliantButDisallowedServices
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."
setCompliantButDisallowedServices
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."
var
string[]
$this
getComplianceRegimeSettings
string
