- [Resource: Actuation](https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#Actuation)
  - [JSON representation](https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#Actuation.SCHEMA_REPRESENTATION)
- [ActuationOutput](https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#ActuationOutput)
  - [JSON representation](https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#ActuationOutput.SCHEMA_REPRESENTATION)
- [ErrorCode](https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#ErrorCode)
- [State](https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#State)
- [DeploymentOutput](https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#DeploymentOutput)
  - [JSON representation](https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#DeploymentOutput.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#METHODS_SUMMARY)

## Resource: Actuation

The Actuation object represents the bootstrap state and output results of deployed infrastructure and software.

| JSON representation |
|---|
| ``` { "name": string, "actuationOutput": { object (`https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#ActuationOutput`) }, "state": enum (`https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#State`), "deploymentOutput": [ { object (`https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#DeploymentOutput`) } ], "startTime": string, "endTime": string } ``` |

| Fields ||
|---|---|
| `name` | `string` The name of the actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}. |
| `actuationOutput` | ``object (`https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#ActuationOutput`)`` Output only. Actuation output. |
| `state` | ``enum (`https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#State`)`` Output only. Actuation state. |
| `deploymentOutput[]` | ``object (`https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#DeploymentOutput`)`` Output only. Deployment output. |
| `startTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Start time stamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `endTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. End time stamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

## ActuationOutput

Message for output of actuation.

| JSON representation |
|---|
| ``` { "blueprintId": string, "terraformTemplate": string, "errorLogs": string, "actuateLogs": string, "errorCode": enum (`https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#ErrorCode`), "ansibleError": string, "cloudbuildId": string, "ansibleFailedTask": [ string ], "terraformError": string, "hasUserFacingErrorMsg": boolean } ``` |

| Fields ||
|---|---|
| `blueprintId` | `string` Reference to the Blueprint Controller deployment and revision resource. |
| `terraformTemplate` | `string` Reference to the Terraform template used. |
| `errorLogs` | `string` A link to the actuation Cloud Build log. |
| `actuateLogs` | `string` A link to the Cloud Storage file that stores build logs. |
| `errorCode` | ``enum (`https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations#ErrorCode`)`` Output only. Code describing any errors that may have occurred. If not specified, there is no error in actuation. |
| `ansibleError` | `string` Output only. Error message returned from Ansible. |
| `cloudbuildId` | `string` Cloud Build instance UUID associated with this revision, without any suffix or prefix |
| `ansibleFailedTask[]` | `string` Output only. Failed task name returned from Ansible. |
| `terraformError` | `string` Output only. Error message returned from Terraform. |
| `hasUserFacingErrorMsg` | `boolean` Output only. Whether the error message is user facing. If true, the error message will be shown in the UI. |

## ErrorCode

Possible errors that can occur with deployments.

| Enums ||
|---|---|
| `ERROR_CODE_UNSPECIFIED` | No error code was specified. |
| `TERRAFORM_FAILED` | General Terraform failure. |
| `PERMISSION_DENIED_IN_TERRAFORM` | Permission error in Terraform. |
| `QUOTA_EXCEED_IN_TERRAFORM` | Quota related error in Terraform. |
| `ANSIBLE_FAILED` | General Ansible failure. |
| `CONSTRAINT_VIOLATION_IN_TERRAFORM` | Constraint related error in Terraform. |
| `RESOURCE_ALREADY_EXISTS_IN_TERRAFORM` | Resource already exists error in Terraform. |
| `RESOURCE_UNAVAILABLE_IN_TERRAFORM` | Resource not found error in Terraform. |
| `PERMISSION_DENIED_IN_ANSIBLE` | Permission denied error in Ansible. |
| `INVALID_SECRET_IN_ANSIBLE` | Secret related error in Ansible. |
| `TERRAFORM_DELETION_FAILED` | General Terraform failure during deletion. |
| `RESOURCE_IN_USE_IN_TERRAFORM_DELETION` | Resource in use error in Terraform deletion. |
| `ANSIBLE_START_FAILED` | Startup failure in Ansible. |

## State

The state of the actuation.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | State unspecified. |
| `INFRA_CREATING` | Creating infrastructure in backend (Terraform applying). |
| `SUCCEEDED` | Success. |
| `FAILED` | Failed either in infra creating, post infra configuring, or infra destroying. |
| `POST_INFRA_CONFIGURING` | Configure workload after infrastructure is ready (Ansible running). |
| `INFRA_DESTROYING` | Destroying infrastructure in backend (Terraform destroying). |
| `TIMEOUT` | Ansible timed out due to losing heartbeat in post infra configuring. |

## DeploymentOutput

Message for output of deployment resource.

| JSON representation |
|---|
| ``` { "name": string, "type": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Name of the resource. |
| `type` | `string` Type of the resource. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations/create` | Creates a new actuation for an existing Deployment. |
| ### `https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations/delete` | Deletes a single Actuation. |
| ### `https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations/get` | Gets details of a single Actuation. |
| ### `https://docs.cloud.google.com/workload-manager/docs/reference/rest/v1/projects.locations.deployments.actuations/list` | Lists Actuations in a given project, location and deployment. |