- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.1.0
- 2.0.0
- 1.1.0
- 1.0.4
- 0.9.0
- 0.8.2
public interface WorkloadOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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 |
List<String> | A list containing the compliantButDisallowedServices. |
getCreateTime()
public abstract 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. |
getCreateTimeOrBuilder()
public abstract 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 |
getDisplayName()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getKmsSettingsOrBuilder()
public abstract 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()
public abstract Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public abstract int getLabelsCount()
Optional. Labels applied to the workload.
map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public abstract 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 abstract 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 abstract 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 |
getName()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
getResourceSettingsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
getResourcesCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getSaaEnrollmentResponseOrBuilder()
public abstract 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 abstract 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 abstract 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 abstract 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. |