Package com.google.cloud.assuredworkloads.v1

Interface WorkloadOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Workload, Workload.Builder
    public interface WorkloadOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        com.google.protobuf.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:
        The bytes for name.

      • getDisplayName

        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:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.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:
        The bytes for displayName.

      • getResourcesList

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

      • getResources

        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

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

      • getResourcesOrBuilderList

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

      • getResourcesOrBuilder

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

      • getComplianceRegimeValue

        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:
        The enum numeric value on the wire for complianceRegime.

      • getComplianceRegime

        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:
        The complianceRegime.

      • hasCreateTime

        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:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.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:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.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];

      • getBillingAccount

        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:
        The billingAccount.

      • getBillingAccountBytes

        com.google.protobuf.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:
        The bytes for billingAccount.

      • getEtag

        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:
        The etag.

      • getEtagBytes

        com.google.protobuf.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:
        The bytes for etag.

      • getLabelsCount

        int getLabelsCount()
         Optional. Labels applied to the workload.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

      • containsLabels

        boolean containsLabels​(String key)
         Optional. Labels applied to the workload.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Optional. Labels applied to the workload.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Optional. Labels applied to the workload.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Optional. Labels applied to the workload.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getProvisionedResourcesParent

        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:
        The provisionedResourcesParent.

      • getProvisionedResourcesParentBytes

        com.google.protobuf.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:
        The bytes for provisionedResourcesParent.

      • hasKmsSettings

        @Deprecated
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:
        Whether the kmsSettings field is set.

      • getKmsSettings

        @Deprecated
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:
        The kmsSettings.

      • getKmsSettingsOrBuilder

        @Deprecated
Workload.KMSSettingsOrBuilder getKmsSettingsOrBuilder()
        Deprecated.
         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];

      • getResourceSettingsList

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

      • getResourceSettings

        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

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

      • getResourceSettingsOrBuilderList

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

      • getResourceSettingsOrBuilder

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

      • getKajEnrollmentStateValue

        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:
        The enum numeric value on the wire for kajEnrollmentState.

      • getKajEnrollmentState

        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:
        The kajEnrollmentState.

      • getEnableSovereignControls

        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:
        The enableSovereignControls.

      • hasSaaEnrollmentResponse

        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:
        Whether the saaEnrollmentResponse field is set.

      • getSaaEnrollmentResponse

        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:
        The saaEnrollmentResponse.

      • getSaaEnrollmentResponseOrBuilder

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

      • getCompliantButDisallowedServicesList

        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:
        A list containing the compliantButDisallowedServices.

      • getCompliantButDisallowedServicesCount

        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:
        The count of compliantButDisallowedServices.

      • getCompliantButDisallowedServices

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The compliantButDisallowedServices at the given index.

      • getCompliantButDisallowedServicesBytes

        com.google.protobuf.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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the compliantButDisallowedServices at the given index.

      • getPartnerValue

        int getPartnerValue()
         Optional. Compliance Regime associated with this workload.
        .google.cloud.assuredworkloads.v1.Workload.Partner partner = 25 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for partner.

      • getPartner

        Workload.Partner getPartner()
         Optional. Compliance Regime associated with this workload.
        .google.cloud.assuredworkloads.v1.Workload.Partner partner = 25 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The partner.