---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_clouddeploy_rollout{% #gcp_clouddeploy_rollout %}

## `active_repair_automation_run`{% #active_repair_automation_run %}

**Type**: `STRING`**Provider name**: `activeRepairAutomationRun`**Description**: Output only. The AutomationRun actively repairing the rollout.

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `annotations`{% #annotations %}

**Type**: `MAP_STRING_STRING`**Provider name**: `annotations`**Description**: Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See [https://google.aip.dev/128#annotations](https://google.aip.dev/128#annotations) for more details such as format and size limitations.

## `approval_state`{% #approval_state %}

**Type**: `STRING`**Provider name**: `approvalState`**Description**: Output only. Approval state of the `Rollout`.**Possible values**:

- `APPROVAL_STATE_UNSPECIFIED` - The `Rollout` has an unspecified approval state.
- `NEEDS_APPROVAL` - The `Rollout` requires approval.
- `DOES_NOT_NEED_APPROVAL` - The `Rollout` does not require approval.
- `APPROVED` - The `Rollout` has been approved.
- `REJECTED` - The `Rollout` has been rejected.

## `approve_time`{% #approve_time %}

**Type**: `TIMESTAMP`**Provider name**: `approveTime`**Description**: Output only. Time at which the `Rollout` was approved.

## `controller_rollout`{% #controller_rollout %}

**Type**: `STRING`**Provider name**: `controllerRollout`**Description**: Output only. Name of the `ControllerRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. Time at which the `Rollout` was created.

## `deploy_end_time`{% #deploy_end_time %}

**Type**: `TIMESTAMP`**Provider name**: `deployEndTime`**Description**: Output only. Time at which the `Rollout` finished deploying.

## `deploy_failure_cause`{% #deploy_failure_cause %}

**Type**: `STRING`**Provider name**: `deployFailureCause`**Description**: Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.**Possible values**:

- `FAILURE_CAUSE_UNSPECIFIED` - No reason for failure is specified.
- `CLOUD_BUILD_UNAVAILABLE` - Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
- `EXECUTION_FAILED` - The deploy operation did not complete successfully; check Cloud Build logs.
- `DEADLINE_EXCEEDED` - Deployment did not complete within the allotted time.
- `RELEASE_FAILED` - Release is in a failed state.
- `RELEASE_ABANDONED` - Release is abandoned.
- `VERIFICATION_CONFIG_NOT_FOUND` - No Skaffold verify configuration was found.
- `CLOUD_BUILD_REQUEST_FAILED` - Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.
- `OPERATION_FEATURE_NOT_SUPPORTED` - A Rollout operation had a feature configured that is not supported.

## `deploy_start_time`{% #deploy_start_time %}

**Type**: `TIMESTAMP`**Provider name**: `deployStartTime`**Description**: Output only. Time at which the `Rollout` started deploying.

## `deploying_build`{% #deploying_build %}

**Type**: `STRING`**Provider name**: `deployingBuild`**Description**: Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`.

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: Optional. Description of the `Rollout` for user purposes. Max length is 255 characters.

## `enqueue_time`{% #enqueue_time %}

**Type**: `TIMESTAMP`**Provider name**: `enqueueTime`**Description**: Output only. Time at which the `Rollout` was enqueued.

## `etag`{% #etag %}

**Type**: `STRING`**Provider name**: `etag`**Description**: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

## `failure_reason`{% #failure_reason %}

**Type**: `STRING`**Provider name**: `failureReason`**Description**: Output only. Additional information about the rollout failure, if available.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `metadata`{% #metadata %}

**Type**: `STRUCT`**Provider name**: `metadata`**Description**: Output only. Metadata contains information about the rollout.

- `automation`**Type**: `STRUCT`**Provider name**: `automation`**Description**: Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.
  - `advance_automation_runs`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `advanceAutomationRuns`**Description**: Output only. The names of the AutomationRuns initiated by an advance rollout rule.
  - `promote_automation_run`**Type**: `STRING`**Provider name**: `promoteAutomationRun`**Description**: Output only. The name of the AutomationRun initiated by a promote release rule.
  - `repair_automation_runs`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `repairAutomationRuns`**Description**: Output only. The names of the AutomationRuns initiated by a repair rollout rule.
- `cloud_run`**Type**: `STRUCT`**Provider name**: `cloudRun`**Description**: Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
  - `job`**Type**: `STRING`**Provider name**: `job`**Description**: Output only. The name of the Cloud Run job that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/jobs/{job_name}`.
  - `revision`**Type**: `STRING`**Provider name**: `revision`**Description**: Output only. The Cloud Run Revision id associated with a `Rollout`.
  - `service`**Type**: `STRING`**Provider name**: `service`**Description**: Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/services/{service}`.
  - `service_urls`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `serviceUrls`**Description**: Output only. The Cloud Run Service urls that are associated with a `Rollout`.
- `custom`**Type**: `STRUCT`**Provider name**: `custom`**Description**: Output only. Custom metadata provided by user-defined `Rollout` operations.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Identifier. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`. The `rollout` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `phases`{% #phases %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `phases`**Description**: Output only. The phases that represent the workflows of this `Rollout`.

- `child_rollout_jobs`**Type**: `STRUCT`**Provider name**: `childRolloutJobs`**Description**: Output only. ChildRollout job composition.
  - `advance_rollout_jobs`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `advanceRolloutJobs`**Description**: Output only. List of AdvanceChildRolloutJobs
    - `advance_child_rollout_job`**Type**: `STRUCT`**Provider name**: `advanceChildRolloutJob`**Description**: Output only. An advanceChildRollout Job.

    - `create_child_rollout_job`**Type**: `STRUCT`**Provider name**: `createChildRolloutJob`**Description**: Output only. A createChildRollout Job.

    - `deploy_job`**Type**: `STRUCT`**Provider name**: `deployJob`**Description**: Output only. A deploy Job.

    - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Output only. The ID of the Job.

    - `job_run`**Type**: `STRING`**Provider name**: `jobRun`**Description**: Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.

    - `postdeploy_job`**Type**: `STRUCT`**Provider name**: `postdeployJob`**Description**: Output only. A postdeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the postdeploy Job executes.

    - `predeploy_job`**Type**: `STRUCT`**Provider name**: `predeployJob`**Description**: Output only. A predeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the predeploy Job executes.

    - `skip_message`**Type**: `STRING`**Provider name**: `skipMessage`**Description**: Output only. Additional information on why the Job was skipped, if available.

    - `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The current state of the Job.**Possible values**:

      - `STATE_UNSPECIFIED` - The Job has an unspecified state.
      - `PENDING` - The Job is waiting for an earlier Phase(s) or Job(s) to complete.
      - `DISABLED` - The Job is disabled.
      - `IN_PROGRESS` - The Job is in progress.
      - `SUCCEEDED` - The Job succeeded.
      - `FAILED` - The Job failed.
      - `ABORTED` - The Job was aborted.
      - `SKIPPED` - The Job was skipped.
      - `IGNORED` - The Job was ignored.

    - `verify_job`**Type**: `STRUCT`**Provider name**: `verifyJob`**Description**: Output only. A verify Job.
  - `create_rollout_jobs`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `createRolloutJobs`**Description**: Output only. List of CreateChildRolloutJobs
    - `advance_child_rollout_job`**Type**: `STRUCT`**Provider name**: `advanceChildRolloutJob`**Description**: Output only. An advanceChildRollout Job.

    - `create_child_rollout_job`**Type**: `STRUCT`**Provider name**: `createChildRolloutJob`**Description**: Output only. A createChildRollout Job.

    - `deploy_job`**Type**: `STRUCT`**Provider name**: `deployJob`**Description**: Output only. A deploy Job.

    - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Output only. The ID of the Job.

    - `job_run`**Type**: `STRING`**Provider name**: `jobRun`**Description**: Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.

    - `postdeploy_job`**Type**: `STRUCT`**Provider name**: `postdeployJob`**Description**: Output only. A postdeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the postdeploy Job executes.

    - `predeploy_job`**Type**: `STRUCT`**Provider name**: `predeployJob`**Description**: Output only. A predeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the predeploy Job executes.

    - `skip_message`**Type**: `STRING`**Provider name**: `skipMessage`**Description**: Output only. Additional information on why the Job was skipped, if available.

    - `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The current state of the Job.**Possible values**:

      - `STATE_UNSPECIFIED` - The Job has an unspecified state.
      - `PENDING` - The Job is waiting for an earlier Phase(s) or Job(s) to complete.
      - `DISABLED` - The Job is disabled.
      - `IN_PROGRESS` - The Job is in progress.
      - `SUCCEEDED` - The Job succeeded.
      - `FAILED` - The Job failed.
      - `ABORTED` - The Job was aborted.
      - `SKIPPED` - The Job was skipped.
      - `IGNORED` - The Job was ignored.

    - `verify_job`**Type**: `STRUCT`**Provider name**: `verifyJob`**Description**: Output only. A verify Job.
- `deployment_jobs`**Type**: `STRUCT`**Provider name**: `deploymentJobs`**Description**: Output only. Deployment job composition.
  - `deploy_job`**Type**: `STRUCT`**Provider name**: `deployJob`**Description**: Output only. The deploy Job. This is the deploy job in the phase.
    - `advance_child_rollout_job`**Type**: `STRUCT`**Provider name**: `advanceChildRolloutJob`**Description**: Output only. An advanceChildRollout Job.

    - `create_child_rollout_job`**Type**: `STRUCT`**Provider name**: `createChildRolloutJob`**Description**: Output only. A createChildRollout Job.

    - `deploy_job`**Type**: `STRUCT`**Provider name**: `deployJob`**Description**: Output only. A deploy Job.

    - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Output only. The ID of the Job.

    - `job_run`**Type**: `STRING`**Provider name**: `jobRun`**Description**: Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.

    - `postdeploy_job`**Type**: `STRUCT`**Provider name**: `postdeployJob`**Description**: Output only. A postdeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the postdeploy Job executes.

    - `predeploy_job`**Type**: `STRUCT`**Provider name**: `predeployJob`**Description**: Output only. A predeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the predeploy Job executes.

    - `skip_message`**Type**: `STRING`**Provider name**: `skipMessage`**Description**: Output only. Additional information on why the Job was skipped, if available.

    - `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The current state of the Job.**Possible values**:

      - `STATE_UNSPECIFIED` - The Job has an unspecified state.
      - `PENDING` - The Job is waiting for an earlier Phase(s) or Job(s) to complete.
      - `DISABLED` - The Job is disabled.
      - `IN_PROGRESS` - The Job is in progress.
      - `SUCCEEDED` - The Job succeeded.
      - `FAILED` - The Job failed.
      - `ABORTED` - The Job was aborted.
      - `SKIPPED` - The Job was skipped.
      - `IGNORED` - The Job was ignored.

    - `verify_job`**Type**: `STRUCT`**Provider name**: `verifyJob`**Description**: Output only. A verify Job.
  - `postdeploy_job`**Type**: `STRUCT`**Provider name**: `postdeployJob`**Description**: Output only. The postdeploy Job, which is the last job on the phase.
    - `advance_child_rollout_job`**Type**: `STRUCT`**Provider name**: `advanceChildRolloutJob`**Description**: Output only. An advanceChildRollout Job.

    - `create_child_rollout_job`**Type**: `STRUCT`**Provider name**: `createChildRolloutJob`**Description**: Output only. A createChildRollout Job.

    - `deploy_job`**Type**: `STRUCT`**Provider name**: `deployJob`**Description**: Output only. A deploy Job.

    - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Output only. The ID of the Job.

    - `job_run`**Type**: `STRING`**Provider name**: `jobRun`**Description**: Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.

    - `postdeploy_job`**Type**: `STRUCT`**Provider name**: `postdeployJob`**Description**: Output only. A postdeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the postdeploy Job executes.

    - `predeploy_job`**Type**: `STRUCT`**Provider name**: `predeployJob`**Description**: Output only. A predeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the predeploy Job executes.

    - `skip_message`**Type**: `STRING`**Provider name**: `skipMessage`**Description**: Output only. Additional information on why the Job was skipped, if available.

    - `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The current state of the Job.**Possible values**:

      - `STATE_UNSPECIFIED` - The Job has an unspecified state.
      - `PENDING` - The Job is waiting for an earlier Phase(s) or Job(s) to complete.
      - `DISABLED` - The Job is disabled.
      - `IN_PROGRESS` - The Job is in progress.
      - `SUCCEEDED` - The Job succeeded.
      - `FAILED` - The Job failed.
      - `ABORTED` - The Job was aborted.
      - `SKIPPED` - The Job was skipped.
      - `IGNORED` - The Job was ignored.

    - `verify_job`**Type**: `STRUCT`**Provider name**: `verifyJob`**Description**: Output only. A verify Job.
  - `predeploy_job`**Type**: `STRUCT`**Provider name**: `predeployJob`**Description**: Output only. The predeploy Job, which is the first job on the phase.
    - `advance_child_rollout_job`**Type**: `STRUCT`**Provider name**: `advanceChildRolloutJob`**Description**: Output only. An advanceChildRollout Job.

    - `create_child_rollout_job`**Type**: `STRUCT`**Provider name**: `createChildRolloutJob`**Description**: Output only. A createChildRollout Job.

    - `deploy_job`**Type**: `STRUCT`**Provider name**: `deployJob`**Description**: Output only. A deploy Job.

    - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Output only. The ID of the Job.

    - `job_run`**Type**: `STRING`**Provider name**: `jobRun`**Description**: Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.

    - `postdeploy_job`**Type**: `STRUCT`**Provider name**: `postdeployJob`**Description**: Output only. A postdeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the postdeploy Job executes.

    - `predeploy_job`**Type**: `STRUCT`**Provider name**: `predeployJob`**Description**: Output only. A predeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the predeploy Job executes.

    - `skip_message`**Type**: `STRING`**Provider name**: `skipMessage`**Description**: Output only. Additional information on why the Job was skipped, if available.

    - `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The current state of the Job.**Possible values**:

      - `STATE_UNSPECIFIED` - The Job has an unspecified state.
      - `PENDING` - The Job is waiting for an earlier Phase(s) or Job(s) to complete.
      - `DISABLED` - The Job is disabled.
      - `IN_PROGRESS` - The Job is in progress.
      - `SUCCEEDED` - The Job succeeded.
      - `FAILED` - The Job failed.
      - `ABORTED` - The Job was aborted.
      - `SKIPPED` - The Job was skipped.
      - `IGNORED` - The Job was ignored.

    - `verify_job`**Type**: `STRUCT`**Provider name**: `verifyJob`**Description**: Output only. A verify Job.
  - `verify_job`**Type**: `STRUCT`**Provider name**: `verifyJob`**Description**: Output only. The verify Job. Runs after a deploy if the deploy succeeds.
    - `advance_child_rollout_job`**Type**: `STRUCT`**Provider name**: `advanceChildRolloutJob`**Description**: Output only. An advanceChildRollout Job.

    - `create_child_rollout_job`**Type**: `STRUCT`**Provider name**: `createChildRolloutJob`**Description**: Output only. A createChildRollout Job.

    - `deploy_job`**Type**: `STRUCT`**Provider name**: `deployJob`**Description**: Output only. A deploy Job.

    - `id`**Type**: `STRING`**Provider name**: `id`**Description**: Output only. The ID of the Job.

    - `job_run`**Type**: `STRING`**Provider name**: `jobRun`**Description**: Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.

    - `postdeploy_job`**Type**: `STRUCT`**Provider name**: `postdeployJob`**Description**: Output only. A postdeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the postdeploy Job executes.

    - `predeploy_job`**Type**: `STRUCT`**Provider name**: `predeployJob`**Description**: Output only. A predeploy Job.

      - `actions`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actions`**Description**: Output only. The custom actions that the predeploy Job executes.

    - `skip_message`**Type**: `STRING`**Provider name**: `skipMessage`**Description**: Output only. Additional information on why the Job was skipped, if available.

    - `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. The current state of the Job.**Possible values**:

      - `STATE_UNSPECIFIED` - The Job has an unspecified state.
      - `PENDING` - The Job is waiting for an earlier Phase(s) or Job(s) to complete.
      - `DISABLED` - The Job is disabled.
      - `IN_PROGRESS` - The Job is in progress.
      - `SUCCEEDED` - The Job succeeded.
      - `FAILED` - The Job failed.
      - `ABORTED` - The Job was aborted.
      - `SKIPPED` - The Job was skipped.
      - `IGNORED` - The Job was ignored.

    - `verify_job`**Type**: `STRUCT`**Provider name**: `verifyJob`**Description**: Output only. A verify Job.
- `id`**Type**: `STRING`**Provider name**: `id`**Description**: Output only. The ID of the Phase.
- `skip_message`**Type**: `STRING`**Provider name**: `skipMessage`**Description**: Output only. Additional information on why the Phase was skipped, if available.
- `state`**Type**: `STRING`**Provider name**: `state`**Description**: Output only. Current state of the Phase.**Possible values**:
  - `STATE_UNSPECIFIED` - The Phase has an unspecified state.
  - `PENDING` - The Phase is waiting for an earlier Phase(s) to complete.
  - `IN_PROGRESS` - The Phase is in progress.
  - `SUCCEEDED` - The Phase has succeeded.
  - `FAILED` - The Phase has failed.
  - `ABORTED` - The Phase was aborted.
  - `SKIPPED` - The Phase was skipped.

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `rollback_of_rollout`{% #rollback_of_rollout %}

**Type**: `STRING`**Provider name**: `rollbackOfRollout`**Description**: Output only. Name of the `Rollout` that is rolled back by this `Rollout`. Empty if this `Rollout` wasn't created as a rollback.

## `rolled_back_by_rollouts`{% #rolled_back_by_rollouts %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `rolledBackByRollouts`**Description**: Output only. Names of `Rollouts` that rolled back this `Rollout`.

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `state`**Description**: Output only. Current state of the `Rollout`.**Possible values**:

- `STATE_UNSPECIFIED` - The `Rollout` has an unspecified state.
- `SUCCEEDED` - The `Rollout` has completed successfully.
- `FAILED` - The `Rollout` has failed.
- `IN_PROGRESS` - The `Rollout` is being deployed.
- `PENDING_APPROVAL` - The `Rollout` needs approval.
- `APPROVAL_REJECTED` - An approver rejected the `Rollout`.
- `PENDING` - The `Rollout` is waiting for an earlier Rollout(s) to complete on this `Target`.
- `PENDING_RELEASE` - The `Rollout` is waiting for the `Release` to be fully rendered.
- `CANCELLING` - The `Rollout` is in the process of being cancelled.
- `CANCELLED` - The `Rollout` has been cancelled.
- `HALTED` - The `Rollout` is halted.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `target_id`{% #target_id %}

**Type**: `STRING`**Provider name**: `targetId`**Description**: Required. The ID of Target to which this `Rollout` is deploying.

## `uid`{% #uid %}

**Type**: `STRING`**Provider name**: `uid`**Description**: Output only. Unique identifier of the `Rollout`.

## `zone_id`{% #zone_id %}

**Type**: `STRING`
