public final class Workload extends GeneratedMessageV3 implements WorkloadOrBuilder
A Workload object for managing highly regulated workloads of cloud
customers.
Protobuf type google.cloud.assuredworkloads.v1.Workload
Static Fields
BILLING_ACCOUNT_FIELD_NUMBER
public static final int BILLING_ACCOUNT_FIELD_NUMBER
Field Value
COMPLIANCE_REGIME_FIELD_NUMBER
public static final int COMPLIANCE_REGIME_FIELD_NUMBER
Field Value
COMPLIANT_BUT_DISALLOWED_SERVICES_FIELD_NUMBER
public static final int COMPLIANT_BUT_DISALLOWED_SERVICES_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ENABLE_SOVEREIGN_CONTROLS_FIELD_NUMBER
public static final int ENABLE_SOVEREIGN_CONTROLS_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
KAJ_ENROLLMENT_STATE_FIELD_NUMBER
public static final int KAJ_ENROLLMENT_STATE_FIELD_NUMBER
Field Value
KMS_SETTINGS_FIELD_NUMBER
public static final int KMS_SETTINGS_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PARTNER_FIELD_NUMBER
public static final int PARTNER_FIELD_NUMBER
Field Value
PROVISIONED_RESOURCES_PARENT_FIELD_NUMBER
public static final int PROVISIONED_RESOURCES_PARENT_FIELD_NUMBER
Field Value
RESOURCES_FIELD_NUMBER
public static final int RESOURCES_FIELD_NUMBER
Field Value
RESOURCE_SETTINGS_FIELD_NUMBER
public static final int RESOURCE_SETTINGS_FIELD_NUMBER
Field Value
SAA_ENROLLMENT_RESPONSE_FIELD_NUMBER
public static final int SAA_ENROLLMENT_RESPONSE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Workload getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Workload.Builder newBuilder()
Returns
newBuilder(Workload prototype)
public static Workload.Builder newBuilder(Workload prototype)
Parameter
Returns
public static Workload parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Workload parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Workload parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Workload parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Workload parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Workload parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Workload parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Workload parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Workload parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Workload parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Workload parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Workload parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Workload> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. Labels applied to the workload.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBillingAccount()
public String getBillingAccount()
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.
string billing_account = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The billingAccount.
|
getBillingAccountBytes()
public ByteString getBillingAccountBytes()
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.
string billing_account = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for billingAccount.
|
getComplianceRegime()
public Workload.ComplianceRegime getComplianceRegime()
Required. Immutable. Compliance Regime associated with this workload.
.google.cloud.assuredworkloads.v1.Workload.ComplianceRegime compliance_regime = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getComplianceRegimeValue()
public int getComplianceRegimeValue()
Required. Immutable. Compliance Regime associated with this workload.
.google.cloud.assuredworkloads.v1.Workload.ComplianceRegime compliance_regime = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
| int | The enum numeric value on the wire for complianceRegime.
|
getCompliantButDisallowedServices(int index)
public String getCompliantButDisallowedServices(int index)
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."
repeated string compliant_but_disallowed_services = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The compliantButDisallowedServices at the given index.
|
getCompliantButDisallowedServicesBytes(int index)
public ByteString getCompliantButDisallowedServicesBytes(int index)
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."
repeated string compliant_but_disallowed_services = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the compliantButDisallowedServices at the given index.
|
getCompliantButDisallowedServicesCount()
public int getCompliantButDisallowedServicesCount()
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."
repeated string compliant_but_disallowed_services = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The count of compliantButDisallowedServices.
|
getCompliantButDisallowedServicesList()
public ProtocolStringList getCompliantButDisallowedServicesList()
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."
repeated string compliant_but_disallowed_services = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime()
public Timestamp getCreateTime()
Output only. Immutable. The Workload creation timestamp.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Immutable. The Workload creation timestamp.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
getDefaultInstanceForType()
public Workload getDefaultInstanceForType()
Returns
getDisplayName()
public String 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 display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
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 display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for displayName.
|
getEnableSovereignControls()
public boolean getEnableSovereignControls()
Optional. Indicates the sovereignty status of the given workload.
Currently meant to be used by Europe/Canada customers.
bool enable_sovereign_controls = 18 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | The enableSovereignControls.
|
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 etag = 9 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Optional. ETag of the workload, it is calculated on the basis
of the Workload contents. It will be used in Update & Delete operations.
string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
getKajEnrollmentState()
public Workload.KajEnrollmentState getKajEnrollmentState()
Output only. Represents the KAJ enrollment state of the given workload.
.google.cloud.assuredworkloads.v1.Workload.KajEnrollmentState kaj_enrollment_state = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
getKajEnrollmentStateValue()
public int getKajEnrollmentStateValue()
Output only. Represents the KAJ enrollment state of the given workload.
.google.cloud.assuredworkloads.v1.Workload.KajEnrollmentState kaj_enrollment_state = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for kajEnrollmentState.
|
getKmsSettings() (deprecated)
public Workload.KMSSettings getKmsSettings()
Deprecated. google.cloud.assuredworkloads.v1.Workload.kms_settings is deprecated. See
google/cloud/assuredworkloads/v1/assuredworkloads.proto;l=484
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.
.google.cloud.assuredworkloads.v1.Workload.KMSSettings kms_settings = 14 [deprecated = true, (.google.api.field_behavior) = INPUT_ONLY];
getKmsSettingsOrBuilder()
public Workload.KMSSettingsOrBuilder getKmsSettingsOrBuilder()
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.
.google.cloud.assuredworkloads.v1.Workload.KMSSettings kms_settings = 14 [deprecated = true, (.google.api.field_behavior) = INPUT_ONLY];
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Optional. Labels applied to the workload.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. Labels applied to the workload.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. Labels applied to the workload.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. Labels applied to the workload.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
getName()
Optional. The resource name of the workload.
Format:
organizations/{organization}/locations/{location}/workloads/{workload}
Read-only.
string name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Optional. The resource name of the workload.
Format:
organizations/{organization}/locations/{location}/workloads/{workload}
Read-only.
string name = 1 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<Workload> getParserForType()
Returns
Overrides
getPartner()
public Workload.Partner getPartner()
Optional. Compliance Regime associated with this workload.
.google.cloud.assuredworkloads.v1.Workload.Partner partner = 25 [(.google.api.field_behavior) = OPTIONAL];
getPartnerValue()
public int getPartnerValue()
Optional. Compliance Regime associated with this workload.
.google.cloud.assuredworkloads.v1.Workload.Partner partner = 25 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int | The enum numeric value on the wire for partner.
|
getProvisionedResourcesParent()
public String 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 provisioned_resources_parent = 13 [(.google.api.field_behavior) = INPUT_ONLY];
| Type | Description |
| String | The provisionedResourcesParent.
|
getProvisionedResourcesParentBytes()
public ByteString getProvisionedResourcesParentBytes()
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 provisioned_resources_parent = 13 [(.google.api.field_behavior) = INPUT_ONLY];
| Type | Description |
| ByteString | The bytes for provisionedResourcesParent.
|
getResourceSettings(int index)
public Workload.ResourceSettings getResourceSettings(int index)
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceSettings resource_settings = 15 [(.google.api.field_behavior) = INPUT_ONLY];
getResourceSettingsCount()
public int getResourceSettingsCount()
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceSettings resource_settings = 15 [(.google.api.field_behavior) = INPUT_ONLY];
getResourceSettingsList()
public List<Workload.ResourceSettings> getResourceSettingsList()
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceSettings resource_settings = 15 [(.google.api.field_behavior) = INPUT_ONLY];
getResourceSettingsOrBuilder(int index)
public Workload.ResourceSettingsOrBuilder getResourceSettingsOrBuilder(int index)
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceSettings resource_settings = 15 [(.google.api.field_behavior) = INPUT_ONLY];
getResourceSettingsOrBuilderList()
public List<? extends Workload.ResourceSettingsOrBuilder> getResourceSettingsOrBuilderList()
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceSettings resource_settings = 15 [(.google.api.field_behavior) = INPUT_ONLY];
| Type | Description |
| List<? extends com.google.cloud.assuredworkloads.v1.Workload.ResourceSettingsOrBuilder> | |
getResources(int index)
public Workload.ResourceInfo getResources(int index)
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceInfo resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getResourcesCount()
public int getResourcesCount()
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceInfo resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getResourcesList()
public List<Workload.ResourceInfo> getResourcesList()
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceInfo resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getResourcesOrBuilder(int index)
public Workload.ResourceInfoOrBuilder getResourcesOrBuilder(int index)
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceInfo resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getResourcesOrBuilderList()
public List<? extends Workload.ResourceInfoOrBuilder> getResourcesOrBuilderList()
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.
repeated .google.cloud.assuredworkloads.v1.Workload.ResourceInfo resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| List<? extends com.google.cloud.assuredworkloads.v1.Workload.ResourceInfoOrBuilder> | |
getSaaEnrollmentResponse()
public Workload.SaaEnrollmentResponse 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.
.google.cloud.assuredworkloads.v1.Workload.SaaEnrollmentResponse saa_enrollment_response = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSaaEnrollmentResponseOrBuilder()
public Workload.SaaEnrollmentResponseOrBuilder getSaaEnrollmentResponseOrBuilder()
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.
.google.cloud.assuredworkloads.v1.Workload.SaaEnrollmentResponse saa_enrollment_response = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCreateTime()
public boolean hasCreateTime()
Output only. Immutable. The Workload creation timestamp.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasKmsSettings() (deprecated)
public boolean hasKmsSettings()
Deprecated. google.cloud.assuredworkloads.v1.Workload.kms_settings is deprecated. See
google/cloud/assuredworkloads/v1/assuredworkloads.proto;l=484
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.
.google.cloud.assuredworkloads.v1.Workload.KMSSettings kms_settings = 14 [deprecated = true, (.google.api.field_behavior) = INPUT_ONLY];
| Type | Description |
| boolean | Whether the kmsSettings field is set.
|
hasSaaEnrollmentResponse()
public boolean hasSaaEnrollmentResponse()
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.
.google.cloud.assuredworkloads.v1.Workload.SaaEnrollmentResponse saa_enrollment_response = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the saaEnrollmentResponse field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Workload.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Workload.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Workload.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
