Assured Workloads v1 API - Class Workload (2.5.0)

public sealed class Workload : IMessage<Workload>, IEquatable<Workload>, IDeepCloneable<Workload>, IBufferMessage, IMessage

Reference documentation and code samples for the Assured Workloads v1 API class Workload.

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

Inheritance

object > Workload

Namespace

Google.Cloud.AssuredWorkloads.V1

Assembly

Google.Cloud.AssuredWorkloads.V1.dll

Constructors

Workload()

public Workload()

Workload(Workload)

public Workload(Workload other)
Parameter
Name Description
other Workload

Properties

BillingAccount

public string BillingAccount { get; set; }

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.

Property Value
Type Description
string

ComplianceRegime

public Workload.Types.ComplianceRegime ComplianceRegime { get; set; }

Required. Immutable. Compliance Regime associated with this workload.

Property Value
Type Description
WorkloadTypesComplianceRegime

CompliantButDisallowedServices

public RepeatedField<string> CompliantButDisallowedServices { get; }

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."

Property Value
Type Description
RepeatedFieldstring

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Immutable. The Workload creation timestamp.

Property Value
Type Description
Timestamp

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type Description
string

EnableSovereignControls

public bool EnableSovereignControls { get; set; }

Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.

Property Value
Type Description
bool

Etag

public string Etag { get; set; }

Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.

Property Value
Type Description
string

KajEnrollmentState

public Workload.Types.KajEnrollmentState KajEnrollmentState { get; set; }

Output only. Represents the KAJ enrollment state of the given workload.

Property Value
Type Description
WorkloadTypesKajEnrollmentState

KmsSettings

[Obsolete]
public Workload.Types.KMSSettings KmsSettings { get; set; }

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.

Property Value
Type Description
WorkloadTypesKMSSettings

Labels

public MapField<string, string> Labels { get; }

Optional. Labels applied to the workload.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload}

Read-only.

Property Value
Type Description
string

Partner

public Workload.Types.Partner Partner { get; set; }

Optional. Compliance Regime associated with this workload.

Property Value
Type Description
WorkloadTypesPartner

ProvisionedResourcesParent

public string ProvisionedResourcesParent { get; set; }

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}

Property Value
Type Description
string

ResourceSettings

public RepeatedField<Workload.Types.ResourceSettings> ResourceSettings { get; }

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.

Property Value
Type Description
RepeatedFieldWorkloadTypesResourceSettings

Resources

public RepeatedField<Workload.Types.ResourceInfo> Resources { get; }

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.

Property Value
Type Description
RepeatedFieldWorkloadTypesResourceInfo

SaaEnrollmentResponse

public Workload.Types.SaaEnrollmentResponse SaaEnrollmentResponse { get; set; }

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.

Property Value
Type Description
WorkloadTypesSaaEnrollmentResponse

WorkloadName

public WorkloadName WorkloadName { get; set; }

WorkloadName-typed view over the Name resource name property.

Property Value
Type Description
WorkloadName