| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="assuredworkloads_v1.html">Assured Workloads API</a> . <a href="assuredworkloads_v1.organizations.html">organizations</a> . <a href="assuredworkloads_v1.organizations.locations.html">locations</a> . <a href="assuredworkloads_v1.organizations.locations.workloads.html">workloads</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, externalId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates Assured Workload.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, etag=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets Assured Workload associated with a CRM Node</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists Assured Workloads under a CRM Node.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, externalId=None, x__xgafv=None)</code> |
| <pre>Creates Assured Workload. |
| |
| Args: |
| parent: string, Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # An Workload object for managing highly regulated workloads of cloud customers. |
| "billingAccount": "A String", # 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`. |
| "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. |
| "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. |
| "displayName": "A 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 |
| "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. |
| "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. |
| "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. |
| "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. |
| "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. |
| "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. |
| }, |
| "labels": { # Optional. Labels applied to the workload. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. |
| "provisionedResourcesParent": "A 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} |
| "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. |
| { # Represent the custom settings for the resources to be created. |
| "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. |
| "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT) |
| }, |
| ], |
| "resources": [ # 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. |
| { # Represent the resources that are children of this Workload. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_number. |
| "resourceType": "A String", # Indicates the type of resource. |
| }, |
| ], |
| "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # 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. |
| "setupErrors": [ # Indicates SAA enrollment setup error if any. |
| "A String", |
| ], |
| "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. |
| }, |
| } |
| |
| externalId: string, Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, etag=None, x__xgafv=None)</code> |
| <pre>Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. |
| |
| Args: |
| name: string, Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id} (required) |
| etag: string, Optional. The etag of the workload. If this is provided, it must match the server's etag. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets Assured Workload associated with a CRM Node |
| |
| Args: |
| name: string, Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1". (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Workload object for managing highly regulated workloads of cloud customers. |
| "billingAccount": "A String", # 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`. |
| "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. |
| "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. |
| "displayName": "A 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 |
| "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. |
| "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. |
| "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. |
| "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. |
| "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. |
| "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. |
| }, |
| "labels": { # Optional. Labels applied to the workload. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. |
| "provisionedResourcesParent": "A 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} |
| "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. |
| { # Represent the custom settings for the resources to be created. |
| "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. |
| "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT) |
| }, |
| ], |
| "resources": [ # 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. |
| { # Represent the resources that are children of this Workload. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_number. |
| "resourceType": "A String", # Indicates the type of resource. |
| }, |
| ], |
| "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # 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. |
| "setupErrors": [ # Indicates SAA enrollment setup error if any. |
| "A String", |
| ], |
| "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists Assured Workloads under a CRM Node. |
| |
| Args: |
| parent: string, Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`. (required) |
| filter: string, A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported. |
| pageSize: integer, Page size. |
| pageToken: string, Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response of ListWorkloads endpoint. |
| "nextPageToken": "A String", # The next page token. Return empty if reached the last page. |
| "workloads": [ # List of Workloads under a given parent. |
| { # An Workload object for managing highly regulated workloads of cloud customers. |
| "billingAccount": "A String", # 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`. |
| "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. |
| "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. |
| "displayName": "A 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 |
| "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. |
| "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. |
| "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. |
| "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. |
| "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. |
| "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. |
| }, |
| "labels": { # Optional. Labels applied to the workload. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. |
| "provisionedResourcesParent": "A 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} |
| "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. |
| { # Represent the custom settings for the resources to be created. |
| "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. |
| "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT) |
| }, |
| ], |
| "resources": [ # 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. |
| { # Represent the resources that are children of this Workload. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_number. |
| "resourceType": "A String", # Indicates the type of resource. |
| }, |
| ], |
| "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # 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. |
| "setupErrors": [ # Indicates SAA enrollment setup error if any. |
| "A String", |
| ], |
| "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress. |
| |
| Args: |
| name: string, Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # An Workload object for managing highly regulated workloads of cloud customers. |
| "billingAccount": "A String", # 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`. |
| "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. |
| "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. |
| "displayName": "A 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 |
| "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. |
| "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. |
| "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. |
| "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. |
| "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. |
| "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. |
| }, |
| "labels": { # Optional. Labels applied to the workload. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. |
| "provisionedResourcesParent": "A 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} |
| "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. |
| { # Represent the custom settings for the resources to be created. |
| "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. |
| "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT) |
| }, |
| ], |
| "resources": [ # 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. |
| { # Represent the resources that are children of this Workload. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_number. |
| "resourceType": "A String", # Indicates the type of resource. |
| }, |
| ], |
| "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # 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. |
| "setupErrors": [ # Indicates SAA enrollment setup error if any. |
| "A String", |
| ], |
| "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. |
| }, |
| } |
| |
| updateMask: string, Required. The list of fields to be updated. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Workload object for managing highly regulated workloads of cloud customers. |
| "billingAccount": "A String", # 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`. |
| "complianceRegime": "A String", # Required. Immutable. Compliance Regime associated with this workload. |
| "createTime": "A String", # Output only. Immutable. The Workload creation timestamp. |
| "displayName": "A 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 |
| "enableSovereignControls": True or False, # Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. |
| "etag": "A String", # Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. |
| "kajEnrollmentState": "A String", # Output only. Represents the KAJ enrollment state of the given workload. |
| "kmsSettings": { # Settings specific to the Key Management Service. # Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes. |
| "nextRotationTime": "A String", # Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary. |
| "rotationPeriod": "A String", # Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. |
| }, |
| "labels": { # Optional. Labels applied to the workload. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. |
| "provisionedResourcesParent": "A 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} |
| "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. |
| { # Represent the custom settings for the resources to be created. |
| "displayName": "A String", # User-assigned resource display name. If not empty it will be used to create a resource with the specified name. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. |
| "resourceType": "A String", # Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT) |
| }, |
| ], |
| "resources": [ # 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. |
| { # Represent the resources that are children of this Workload. |
| "resourceId": "A String", # Resource identifier. For a project this represents project_number. |
| "resourceType": "A String", # Indicates the type of resource. |
| }, |
| ], |
| "saaEnrollmentResponse": { # Signed Access Approvals (SAA) enrollment response. # 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. |
| "setupErrors": [ # Indicates SAA enrollment setup error if any. |
| "A String", |
| ], |
| "setupStatus": "A String", # Indicates SAA enrollment status of a given workload. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
