Class Workload.Builder (2.55.0) 

public static final class Workload.Builder extends GeneratedMessageV3.Builder<Workload.Builder> implements WorkloadOrBuilder

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

Protobuf type google.cloud.assuredworkloads.v1.Workload

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Workload.Builder

Implements

WorkloadOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllCompliantButDisallowedServices(Iterable<String> values)

public Workload.Builder addAllCompliantButDisallowedServices(Iterable<String> values)

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];

Parameter
Name Description
values Iterable<String>

The compliantButDisallowedServices to add.
Returns
Type Description
Workload.Builder

This builder for chaining.

addAllResourceSettings(Iterable<? extends Workload.ResourceSettings> values)

public Workload.Builder addAllResourceSettings(Iterable<? extends Workload.ResourceSettings> values)

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];

Parameter
Name Description
values Iterable<? extends com.google.cloud.assuredworkloads.v1.Workload.ResourceSettings>
Returns
Type Description
Workload.Builder

addAllResources(Iterable<? extends Workload.ResourceInfo> values)

public Workload.Builder addAllResources(Iterable<? extends Workload.ResourceInfo> values)

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];

Parameter
Name Description
values Iterable<? extends com.google.cloud.assuredworkloads.v1.Workload.ResourceInfo>
Returns
Type Description
Workload.Builder

addCompliantButDisallowedServices(String value)

public Workload.Builder addCompliantButDisallowedServices(String value)

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];

Parameter
Name Description
value String

The compliantButDisallowedServices to add.
Returns
Type Description
Workload.Builder

This builder for chaining.

addCompliantButDisallowedServicesBytes(ByteString value)

public Workload.Builder addCompliantButDisallowedServicesBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes of the compliantButDisallowedServices to add.
Returns
Type Description
Workload.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Workload.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Workload.Builder
Overrides

addResourceSettings(Workload.ResourceSettings value)

public Workload.Builder addResourceSettings(Workload.ResourceSettings value)

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];

Parameter
Name Description
value Workload.ResourceSettings
Returns
Type Description
Workload.Builder

addResourceSettings(Workload.ResourceSettings.Builder builderForValue)

public Workload.Builder addResourceSettings(Workload.ResourceSettings.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Workload.ResourceSettings.Builder
Returns
Type Description
Workload.Builder

addResourceSettings(int index, Workload.ResourceSettings value)

public Workload.Builder addResourceSettings(int index, Workload.ResourceSettings value)

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];

Parameters
Name Description
index int
value Workload.ResourceSettings
Returns
Type Description
Workload.Builder

addResourceSettings(int index, Workload.ResourceSettings.Builder builderForValue)

public Workload.Builder addResourceSettings(int index, Workload.ResourceSettings.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Workload.ResourceSettings.Builder
Returns
Type Description
Workload.Builder

addResourceSettingsBuilder()

public Workload.ResourceSettings.Builder addResourceSettingsBuilder()

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];

Returns
Type Description
Workload.ResourceSettings.Builder

addResourceSettingsBuilder(int index)

public Workload.ResourceSettings.Builder addResourceSettingsBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
Workload.ResourceSettings.Builder

addResources(Workload.ResourceInfo value)

public Workload.Builder addResources(Workload.ResourceInfo value)

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];

Parameter
Name Description
value Workload.ResourceInfo
Returns
Type Description
Workload.Builder

addResources(Workload.ResourceInfo.Builder builderForValue)

public Workload.Builder addResources(Workload.ResourceInfo.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Workload.ResourceInfo.Builder
Returns
Type Description
Workload.Builder

addResources(int index, Workload.ResourceInfo value)

public Workload.Builder addResources(int index, Workload.ResourceInfo value)

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];

Parameters
Name Description
index int
value Workload.ResourceInfo
Returns
Type Description
Workload.Builder

addResources(int index, Workload.ResourceInfo.Builder builderForValue)

public Workload.Builder addResources(int index, Workload.ResourceInfo.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Workload.ResourceInfo.Builder
Returns
Type Description
Workload.Builder

addResourcesBuilder()

public Workload.ResourceInfo.Builder addResourcesBuilder()

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];

Returns
Type Description
Workload.ResourceInfo.Builder

addResourcesBuilder(int index)

public Workload.ResourceInfo.Builder addResourcesBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
Workload.ResourceInfo.Builder

build()

public Workload build()
Returns
Type Description
Workload

buildPartial()

public Workload buildPartial()
Returns
Type Description
Workload

clear()

public Workload.Builder clear()
Returns
Type Description
Workload.Builder
Overrides

clearBillingAccount()

public Workload.Builder clearBillingAccount()

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];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearComplianceRegime()

public Workload.Builder clearComplianceRegime()

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];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearCompliantButDisallowedServices()

public Workload.Builder clearCompliantButDisallowedServices()

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];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearCreateTime()

public Workload.Builder clearCreateTime()

Output only. Immutable. The Workload creation timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Workload.Builder

clearDisplayName()

public Workload.Builder clearDisplayName()

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];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearEnableSovereignControls()

public Workload.Builder clearEnableSovereignControls()

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];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearEtag()

public Workload.Builder clearEtag()

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];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Workload.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Workload.Builder
Overrides

clearKajEnrollmentState()

public Workload.Builder clearKajEnrollmentState()

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];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearKmsSettings() (deprecated)

public Workload.Builder clearKmsSettings()

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];

Returns
Type Description
Workload.Builder

clearLabels()

public Workload.Builder clearLabels()
Returns
Type Description
Workload.Builder

clearName()

public Workload.Builder clearName()

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

Read-only.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Workload.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Workload.Builder
Overrides

clearPartner()

public Workload.Builder clearPartner()

Optional. Compliance Regime associated with this workload.

.google.cloud.assuredworkloads.v1.Workload.Partner partner = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearProvisionedResourcesParent()

public Workload.Builder clearProvisionedResourcesParent()

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];

Returns
Type Description
Workload.Builder

This builder for chaining.

clearResourceSettings()

public Workload.Builder clearResourceSettings()

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];

Returns
Type Description
Workload.Builder

clearResources()

public Workload.Builder clearResources()

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];

Returns
Type Description
Workload.Builder

clearSaaEnrollmentResponse()

public Workload.Builder clearSaaEnrollmentResponse()

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];

Returns
Type Description
Workload.Builder

clone()

public Workload.Builder clone()
Returns
Type Description
Workload.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels applied to the workload.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

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];

Returns
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];

Returns
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];

Returns
Type Description
Workload.ComplianceRegime

The complianceRegime.

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];

Returns
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];

Parameter
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];

Parameter
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];

Returns
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];

Returns
Type Description
ProtocolStringList

A list containing the compliantButDisallowedServices.

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];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Immutable. The Workload creation timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Builder

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];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Workload getDefaultInstanceForType()
Returns
Type Description
Workload

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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];

Returns
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];

Returns
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];

Returns
Type Description
boolean

The enableSovereignControls.

getEtag()

public String 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];

Returns
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];

Returns
Type Description
ByteString

The bytes for etag.

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];

Returns
Type Description
Workload.KajEnrollmentState

The kajEnrollmentState.

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];

Returns
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];

Returns
Type Description
Workload.KMSSettings

The kmsSettings.

getKmsSettingsBuilder() (deprecated)

public Workload.KMSSettings.Builder getKmsSettingsBuilder()

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];

Returns
Type Description
Workload.KMSSettings.Builder

getKmsSettingsOrBuilder() (deprecated)

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];

Returns
Type Description
Workload.KMSSettingsOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels applied to the workload.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels applied to the workload.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

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];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels applied to the workload.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String 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];

Returns
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];

Returns
Type Description
ByteString

The bytes for name.

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];

Returns
Type Description
Workload.Partner

The partner.

getPartnerValue()

public int getPartnerValue()

Optional. Compliance Regime associated with this workload.

.google.cloud.assuredworkloads.v1.Workload.Partner partner = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
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];

Returns
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];

Returns
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];

Parameter
Name Description
index int
Returns
Type Description
Workload.ResourceSettings

getResourceSettingsBuilder(int index)

public Workload.ResourceSettings.Builder getResourceSettingsBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
Workload.ResourceSettings.Builder

getResourceSettingsBuilderList()

public List<Workload.ResourceSettings.Builder> getResourceSettingsBuilderList()

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];

Returns
Type Description
List<Builder>

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];

Returns
Type Description
int

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];

Returns
Type Description
List<ResourceSettings>

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];

Parameter
Name Description
index int
Returns
Type Description
Workload.ResourceSettingsOrBuilder

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];

Returns
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];

Parameter
Name Description
index int
Returns
Type Description
Workload.ResourceInfo

getResourcesBuilder(int index)

public Workload.ResourceInfo.Builder getResourcesBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
Workload.ResourceInfo.Builder

getResourcesBuilderList()

public List<Workload.ResourceInfo.Builder> getResourcesBuilderList()

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];

Returns
Type Description
List<Builder>

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];

Returns
Type Description
int

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];

Returns
Type Description
List<ResourceInfo>

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];

Parameter
Name Description
index int
Returns
Type Description
Workload.ResourceInfoOrBuilder

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];

Returns
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];

Returns
Type Description
Workload.SaaEnrollmentResponse

The saaEnrollmentResponse.

getSaaEnrollmentResponseBuilder()

public Workload.SaaEnrollmentResponse.Builder getSaaEnrollmentResponseBuilder()

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];

Returns
Type Description
Workload.SaaEnrollmentResponse.Builder

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];

Returns
Type Description
Workload.SaaEnrollmentResponseOrBuilder

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];

Returns
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];

Returns
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];

Returns
Type Description
boolean

Whether the saaEnrollmentResponse field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Workload.Builder mergeCreateTime(Timestamp value)

Output only. Immutable. The Workload creation timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workload.Builder

mergeFrom(Workload other)

public Workload.Builder mergeFrom(Workload other)
Parameter
Name Description
other Workload
Returns
Type Description
Workload.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Workload.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Workload.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Workload.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Workload.Builder
Overrides

mergeKmsSettings(Workload.KMSSettings value) (deprecated)

public Workload.Builder mergeKmsSettings(Workload.KMSSettings value)

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];

Parameter
Name Description
value Workload.KMSSettings
Returns
Type Description
Workload.Builder

mergeSaaEnrollmentResponse(Workload.SaaEnrollmentResponse value)

public Workload.Builder mergeSaaEnrollmentResponse(Workload.SaaEnrollmentResponse value)

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];

Parameter
Name Description
value Workload.SaaEnrollmentResponse
Returns
Type Description
Workload.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Workload.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Workload.Builder
Overrides

putAllLabels(Map<String,String> values)

public Workload.Builder putAllLabels(Map<String,String> values)

Optional. Labels applied to the workload.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Workload.Builder

putLabels(String key, String value)

public Workload.Builder putLabels(String key, String value)

Optional. Labels applied to the workload.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
Workload.Builder

removeLabels(String key)

public Workload.Builder removeLabels(String key)

Optional. Labels applied to the workload.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Workload.Builder

removeResourceSettings(int index)

public Workload.Builder removeResourceSettings(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];

Parameter
Name Description
index int
Returns
Type Description
Workload.Builder

removeResources(int index)

public Workload.Builder removeResources(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];

Parameter
Name Description
index int
Returns
Type Description
Workload.Builder

setBillingAccount(String value)

public Workload.Builder setBillingAccount(String value)

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];

Parameter
Name Description
value String

The billingAccount to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setBillingAccountBytes(ByteString value)

public Workload.Builder setBillingAccountBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for billingAccount to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setComplianceRegime(Workload.ComplianceRegime value)

public Workload.Builder setComplianceRegime(Workload.ComplianceRegime value)

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];

Parameter
Name Description
value Workload.ComplianceRegime

The complianceRegime to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setComplianceRegimeValue(int value)

public Workload.Builder setComplianceRegimeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for complianceRegime to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setCompliantButDisallowedServices(int index, String value)

public Workload.Builder setCompliantButDisallowedServices(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.
value String

The compliantButDisallowedServices to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Workload.Builder setCreateTime(Timestamp value)

Output only. Immutable. The Workload creation timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value Timestamp
Returns
Type Description
Workload.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Workload.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Immutable. The Workload creation timestamp.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Workload.Builder

setDisplayName(String value)

public Workload.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Workload.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setEnableSovereignControls(boolean value)

public Workload.Builder setEnableSovereignControls(boolean value)

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];

Parameter
Name Description
value boolean

The enableSovereignControls to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setEtag(String value)

public Workload.Builder setEtag(String value)

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];

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Workload.Builder setEtagBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Workload.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Workload.Builder
Overrides

setKajEnrollmentState(Workload.KajEnrollmentState value)

public Workload.Builder setKajEnrollmentState(Workload.KajEnrollmentState value)

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];

Parameter
Name Description
value Workload.KajEnrollmentState

The kajEnrollmentState to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setKajEnrollmentStateValue(int value)

public Workload.Builder setKajEnrollmentStateValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for kajEnrollmentState to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setKmsSettings(Workload.KMSSettings value) (deprecated)

public Workload.Builder setKmsSettings(Workload.KMSSettings value)

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];

Parameter
Name Description
value Workload.KMSSettings
Returns
Type Description
Workload.Builder

setKmsSettings(Workload.KMSSettings.Builder builderForValue) (deprecated)

public Workload.Builder setKmsSettings(Workload.KMSSettings.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Workload.KMSSettings.Builder
Returns
Type Description
Workload.Builder

setName(String value)

public Workload.Builder setName(String value)

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

Read-only.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Workload.Builder setNameBytes(ByteString value)

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

Read-only.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setPartner(Workload.Partner value)

public Workload.Builder setPartner(Workload.Partner value)

Optional. Compliance Regime associated with this workload.

.google.cloud.assuredworkloads.v1.Workload.Partner partner = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Workload.Partner

The partner to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setPartnerValue(int value)

public Workload.Builder setPartnerValue(int value)

Optional. Compliance Regime associated with this workload.

.google.cloud.assuredworkloads.v1.Workload.Partner partner = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for partner to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setProvisionedResourcesParent(String value)

public Workload.Builder setProvisionedResourcesParent(String value)

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];

Parameter
Name Description
value String

The provisionedResourcesParent to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setProvisionedResourcesParentBytes(ByteString value)

public Workload.Builder setProvisionedResourcesParentBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for provisionedResourcesParent to set.
Returns
Type Description
Workload.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Workload.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Workload.Builder
Overrides

setResourceSettings(int index, Workload.ResourceSettings value)

public Workload.Builder setResourceSettings(int index, Workload.ResourceSettings value)

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];

Parameters
Name Description
index int
value Workload.ResourceSettings
Returns
Type Description
Workload.Builder

setResourceSettings(int index, Workload.ResourceSettings.Builder builderForValue)

public Workload.Builder setResourceSettings(int index, Workload.ResourceSettings.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Workload.ResourceSettings.Builder
Returns
Type Description
Workload.Builder

setResources(int index, Workload.ResourceInfo value)

public Workload.Builder setResources(int index, Workload.ResourceInfo value)

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];

Parameters
Name Description
index int
value Workload.ResourceInfo
Returns
Type Description
Workload.Builder

setResources(int index, Workload.ResourceInfo.Builder builderForValue)

public Workload.Builder setResources(int index, Workload.ResourceInfo.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Workload.ResourceInfo.Builder
Returns
Type Description
Workload.Builder

setSaaEnrollmentResponse(Workload.SaaEnrollmentResponse value)

public Workload.Builder setSaaEnrollmentResponse(Workload.SaaEnrollmentResponse value)

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];

Parameter
Name Description
value Workload.SaaEnrollmentResponse
Returns
Type Description
Workload.Builder

setSaaEnrollmentResponse(Workload.SaaEnrollmentResponse.Builder builderForValue)

public Workload.Builder setSaaEnrollmentResponse(Workload.SaaEnrollmentResponse.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Workload.SaaEnrollmentResponse.Builder
Returns
Type Description
Workload.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Workload.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Workload.Builder
Overrides