Reference documentation and code samples for the Assured Workloads for Government V1beta1 API class Google::Cloud::AssuredWorkloads::V1beta1::Workload.
An Workload object for managing highly regulated workloads of cloud customers.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#billing_account
def billing_account() -> ::String
Returns
-
(::String) — Output only. 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
.
#cjis_settings
def cjis_settings() -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::CJISSettings
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::CJISSettings) — Input only. Immutable. Settings specific to resources needed for CJIS.
#cjis_settings=
def cjis_settings=(value) -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::CJISSettings
Parameter
- value (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::CJISSettings) — Input only. Immutable. Settings specific to resources needed for CJIS.
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::CJISSettings) — Input only. Immutable. Settings specific to resources needed for CJIS.
#compliance_regime
def compliance_regime() -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ComplianceRegime
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ComplianceRegime) — Required. Immutable. Compliance Regime associated with this workload.
#compliance_regime=
def compliance_regime=(value) -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ComplianceRegime
Parameter
- value (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ComplianceRegime) — Required. Immutable. Compliance Regime associated with this workload.
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ComplianceRegime) — Required. Immutable. Compliance Regime associated with this workload.
#compliant_but_disallowed_services
def compliant_but_disallowed_services() -> ::Array<::String>
Returns
- (::Array<::String>) — 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."
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Immutable. The Workload creation timestamp.
#display_name
def display_name() -> ::String
Returns
-
(::String) — 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
#display_name=
def display_name=(value) -> ::String
Parameter
-
value (::String) — 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
Returns
-
(::String) — 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
#enable_sovereign_controls
def enable_sovereign_controls() -> ::Boolean
Returns
- (::Boolean) — Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
#enable_sovereign_controls=
def enable_sovereign_controls=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
Returns
- (::Boolean) — Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
#etag
def etag() -> ::String
Returns
- (::String) — Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
#etag=
def etag=(value) -> ::String
Parameter
- value (::String) — Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
Returns
- (::String) — Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.
#fedramp_high_settings
def fedramp_high_settings() -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampHighSettings
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampHighSettings) — Input only. Immutable. Settings specific to resources needed for FedRAMP High.
#fedramp_high_settings=
def fedramp_high_settings=(value) -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampHighSettings
Parameter
- value (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampHighSettings) — Input only. Immutable. Settings specific to resources needed for FedRAMP High.
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampHighSettings) — Input only. Immutable. Settings specific to resources needed for FedRAMP High.
#fedramp_moderate_settings
def fedramp_moderate_settings() -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampModerateSettings
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampModerateSettings) — Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
#fedramp_moderate_settings=
def fedramp_moderate_settings=(value) -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampModerateSettings
Parameter
- value (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampModerateSettings) — Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::FedrampModerateSettings) — Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate.
#il4_settings
def il4_settings() -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::IL4Settings
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::IL4Settings) — Input only. Immutable. Settings specific to resources needed for IL4.
#il4_settings=
def il4_settings=(value) -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::IL4Settings
Parameter
- value (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::IL4Settings) — Input only. Immutable. Settings specific to resources needed for IL4.
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::IL4Settings) — Input only. Immutable. Settings specific to resources needed for IL4.
#kaj_enrollment_state
def kaj_enrollment_state() -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KajEnrollmentState
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KajEnrollmentState) — Output only. Represents the KAJ enrollment state of the given workload.
#kms_settings
def kms_settings() -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KMSSettings
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KMSSettings) — 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.
#kms_settings=
def kms_settings=(value) -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KMSSettings
Parameter
- value (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KMSSettings) — 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.
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::KMSSettings) — 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.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels applied to the workload.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels applied to the workload.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels applied to the workload.
#name
def name() -> ::String
Returns
-
(::String) — Optional. The resource name of the workload.
Format:
organizations/{organization}/locations/{location}/workloads/{workload}
Read-only.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Optional. The resource name of the workload.
Format:
organizations/{organization}/locations/{location}/workloads/{workload}
Read-only.
Returns
-
(::String) — Optional. The resource name of the workload.
Format:
organizations/{organization}/locations/{location}/workloads/{workload}
Read-only.
#provisioned_resources_parent
def provisioned_resources_parent() -> ::String
Returns
- (::String) — 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}
#provisioned_resources_parent=
def provisioned_resources_parent=(value) -> ::String
Parameter
- value (::String) — 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}
Returns
- (::String) — 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}
#resource_settings
def resource_settings() -> ::Array<::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ResourceSettings>
Returns
- (::Array<::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ResourceSettings>) — 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.
#resource_settings=
def resource_settings=(value) -> ::Array<::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ResourceSettings>
Parameter
- value (::Array<::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ResourceSettings>) — 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.
Returns
- (::Array<::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ResourceSettings>) — 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.
#resources
def resources() -> ::Array<::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ResourceInfo>
Returns
- (::Array<::Google::Cloud::AssuredWorkloads::V1beta1::Workload::ResourceInfo>) — 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.
#saa_enrollment_response
def saa_enrollment_response() -> ::Google::Cloud::AssuredWorkloads::V1beta1::Workload::SaaEnrollmentResponse
Returns
- (::Google::Cloud::AssuredWorkloads::V1beta1::Workload::SaaEnrollmentResponse) — 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.