package google.events.cloud.deploy.v1

Get desktop application:
View/edit binary Protocol Buffers messages

An advanceChildRollout Job.

Used in: Job

(message has no fields)

The `AdvanceRollout` automation rule will automatically advance a successful Rollout to the next phase.

Used in: AutomationRule

• string id = 1

  Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z][a-z0-9\-]{0,62}`.

• repeated string source_phases = 6

  Optional. Proceeds only after phase name matched any one in the list. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.

• optional protobuf.Duration wait = 3

  Optional. How long to wait after a rollout is finished.

• optional AutomationRuleCondition condition = 5

  Output only. Information around the state of the Automation rule.

Information specifying an Anthos Cluster.

Used in: Target

• string membership = 1

  Membership of the GKE Hub-registered cluster to which to apply the Skaffold configuration. Format is `projects/{project}/locations/{location}/memberships/{membership_name}`.

An `Automation` resource in the Cloud Deploy API. An `Automation` enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.

Used in: AutomationEventData

• string name = 1

  Output only. Name of the `Automation`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.

• string uid = 2

  Output only. Unique identifier of the `Automation`.

• string description = 3

  Optional. Description of the `Automation`. Max length is 255 characters.

• optional protobuf.Timestamp create_time = 4

  Output only. Time at which the automation was created.

• optional protobuf.Timestamp update_time = 5

  Output only. Time at which the automation was updated.

• map<string, string> annotations = 6

  Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.

• map<string, string> labels = 7

  Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 63 characters.

• string etag = 8

  Optional. The weak etag of the `Automation` resource. 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.

• bool suspended = 9

  Optional. When Suspended, automation is deactivated from execution.

• string service_account = 10

  Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.

• optional AutomationResourceSelector selector = 11

  Required. Selected resources to which the automation will be applied.

• repeated AutomationRule rules = 14

  Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.

The CloudEvent raised when a Automation is created.

• optional AutomationEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Automation is deleted.

• optional AutomationEventData data = 1

  The data associated with the event.

The data within all Automation events.

Used in: AutomationCreatedEvent, AutomationDeletedEvent, AutomationUpdatedEvent

• optional Automation payload = 1

  Optional. The Automation event payload. Unset for deletion events.

AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied.

Used in: Automation

• repeated TargetAttribute targets = 1

  Contains attributes about a target.

AutomationRolloutMetadata contains Automation-related actions that were performed on a rollout.

Used in: Metadata

• string promote_automation_run = 1

  Output only. The ID of the AutomationRun initiated by a promote release rule.

• repeated string advance_automation_runs = 2

  Output only. The IDs of the AutomationRuns initiated by an advance rollout rule.

• repeated string repair_automation_runs = 3

  Output only. The IDs of the AutomationRuns initiated by a repair rollout rule.

• string current_repair_automation_run = 4

  Output only. The current AutomationRun repairing the rollout.

`AutomationRule` defines the automation activities.

Used in: Automation

• oneof rule

  The configuration of the Automation rule.

  • PromoteReleaseRule promote_release_rule = 1

    Optional. `PromoteReleaseRule` will automatically promote a release from the current target to a specified target.

  • AdvanceRolloutRule advance_rollout_rule = 2

    Optional. The `AdvanceRolloutRule` will automatically advance a successful Rollout.

  • RepairRolloutRule repair_rollout_rule = 3

    Optional. The `RepairRolloutRule` will automatically repair a failed rollout.

`AutomationRuleCondition` contains conditions relevant to an `Automation` rule.

Used in: AdvanceRolloutRule, PromoteReleaseRule, RepairRolloutRule

• optional TargetsPresentCondition targets_present_condition = 1

  Optional. Details around targets enumerated in the rule.

The CloudEvent raised when a Automation is updated.

• optional AutomationEventData data = 1

  The data associated with the event.

The pattern of how wait time is increased.

Used in: Retry

• BACKOFF_MODE_UNSPECIFIED = 0

  No WaitMode is specified.

• BACKOFF_MODE_LINEAR = 1

  Increases the wait time linearly.

• BACKOFF_MODE_EXPONENTIAL = 2

  Increases the wait time exponentially.

Description of an a image to use during Skaffold rendering.

Used in: Release

• string image = 3

  Image name in Skaffold configuration.

• string tag = 2

  Image tag to use. This will generally be the full path to an image, such as "gcr.io/my-project/busybox:1.2.3" or "gcr.io/my-project/busybox@sha256:abc123".

Canary represents the canary deployment strategy.

Used in: Strategy

• optional RuntimeConfig runtime_config = 1

  Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.

• oneof mode

  The mode to use for the canary deployment strategy.

  • CanaryDeployment canary_deployment = 2

    Configures the progressive based deployment for a Target.

  • CustomCanaryDeployment custom_canary_deployment = 3

    Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.

CanaryDeployment represents the canary deployment configuration

Used in: Canary

• repeated int32 percentages = 1

  Required. The percentage based deployments that will occur as a part of a `Rollout`. List is expected in ascending order and each integer n is 0 <= n < 100.

• bool verify = 2

  Whether to run verify tests after each percentage deployment.

• optional Predeploy predeploy = 3

  Optional. Configuration for the predeploy job of the first phase. If this is not configured, there will be no predeploy job for this phase.

• optional Postdeploy postdeploy = 4

  Optional. Configuration for the postdeploy job of the last phase. If this is not configured, there will be no postdeploy job for this phase.

ChildRollouts job composition

Used in: Phase

• repeated Job create_rollout_jobs = 1

  Output only. List of CreateChildRolloutJobs

• repeated Job advance_rollout_jobs = 2

  Output only. List of AdvanceChildRolloutJobs

CloudRunConfig contains the Cloud Run runtime configuration.

Used in: RuntimeConfig

• bool automatic_traffic_control = 1

  Whether Cloud Deploy should update the traffic stanza in a Cloud Run Service on the user's behalf to facilitate traffic splitting. This is required to be true for CanaryDeployments, but optional for CustomCanaryDeployments.

• repeated string canary_revision_tags = 2

  Optional. A list of tags that are added to the canary revision while the canary phase is in progress.

• repeated string prior_revision_tags = 3

  Optional. A list of tags that are added to the prior revision while the canary phase is in progress.

• repeated string stable_revision_tags = 4

  Optional. A list of tags that are added to the final stable revision when the stable phase is applied.

Information specifying where to deploy a Cloud Run Service.

Used in: Target

• string location = 1

  Required. The location for the Cloud Run Service. Format must be `projects/{project}/locations/{location}`.

CloudRunMetadata contains information from a Cloud Run deployment.

Used in: Metadata

• string service = 1

  Output only. The name of the Cloud Run Service that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/services/{service}`.

• repeated string service_urls = 2

  Output only. The Cloud Run Service urls that are associated with a `Rollout`.

• string revision = 3

  Output only. The Cloud Run Revision id associated with a `Rollout`.

• string job = 4

  Output only. The name of the Cloud Run job that is associated with a `Rollout`. Format is `projects/{project}/locations/{location}/jobs/{job_name}`.

CloudRunRenderMetadata contains Cloud Run information associated with a `Release` render.

Used in: RenderMetadata

• string service = 1

  Output only. The name of the Cloud Run Service in the rendered manifest. Format is `projects/{project}/locations/{location}/services/{service}`.

A createChildRollout Job.

Used in: Job

(message has no fields)

CustomCanaryDeployment represents the custom canary deployment configuration.

Used in: Canary

• repeated CustomCanaryDeployment.PhaseConfig phase_configs = 1

  Required. Configuration for each phase in the canary deployment in the order executed.

PhaseConfig represents the configuration for a phase in the custom canary deployment.

Used in: CustomCanaryDeployment

• string phase_id = 1

  Required. The ID to assign to the `Rollout` phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.

• int32 percentage = 2

  Required. Percentage deployment for the phase.

• repeated string profiles = 3

  Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.

• bool verify = 4

  Whether to run verify tests after the deployment.

• optional Predeploy predeploy = 5

  Optional. Configuration for the predeploy job of this phase. If this is not configured, there will be no predeploy job for this phase.

• optional Postdeploy postdeploy = 6

  Optional. Configuration for the postdeploy job of this phase. If this is not configured, there will be no postdeploy job for this phase.

CustomMetadata contains information from a user-defined operation.

Used in: Metadata, RenderMetadata

• map<string, string> values = 1

  Output only. Key-value pairs provided by the user-defined operation.

Information specifying a Custom Target.

Used in: Target

• string custom_target_type = 1

  Required. The name of the CustomTargetType. Format must be `projects/{project}/locations/{location}/customTargetTypes/{custom_target_type}`.

CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions.

Used in: CustomTargetType

• string render_action = 1

  Optional. The Skaffold custom action responsible for render operations. If not provided then Cloud Deploy will perform the render operations via `skaffold render`.

• string deploy_action = 2

  Required. The Skaffold custom action responsible for deploy operations.

• repeated SkaffoldModules include_skaffold_modules = 3

  Optional. List of Skaffold modules Cloud Deploy will include in the Skaffold Config as required before performing diagnose.

A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` defines a type of custom target that can be referenced in a `Target` in order to facilitate deploying to other systems besides the supported runtimes.

Used in: CustomTargetTypeEventData, Release

• string name = 1

  Optional. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/[a-z][a-z0-9\-]{0,62}`.

• string custom_target_type_id = 2

  Output only. Resource id of the `CustomTargetType`.

• string uid = 3

  Output only. Unique identifier of the `CustomTargetType`.

• string description = 4

  Optional. Description of the `CustomTargetType`. Max length is 255 characters.

• map<string, string> annotations = 5

  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 for more details such as format and size limitations.

• map<string, string> labels = 6

  Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

• optional protobuf.Timestamp create_time = 7

  Output only. Time at which the `CustomTargetType` was created.

• optional protobuf.Timestamp update_time = 8

  Output only. Most recent time at which the `CustomTargetType` was updated.

• string etag = 9

  Optional. 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.

• oneof definition

  Defines the `CustomTargetType` renderer and deployer.

  • CustomTargetSkaffoldActions custom_actions = 10

    Configures render and deploy for the `CustomTargetType` using Skaffold custom actions.

The CloudEvent raised when a CustomTargetType is created.

• optional CustomTargetTypeEventData data = 1

  The data associated with the event.

The CloudEvent raised when a CustomTargetType is deleted.

• optional CustomTargetTypeEventData data = 1

  The data associated with the event.

The data within all CustomTargetType events.

Used in: CustomTargetTypeCreatedEvent, CustomTargetTypeDeletedEvent, CustomTargetTypeUpdatedEvent

• optional CustomTargetType payload = 1

  Optional. The CustomTargetType event payload. Unset for deletion events.

The CloudEvent raised when a CustomTargetType is updated.

• optional CustomTargetTypeEventData data = 1

  The data associated with the event.

Execution using the default Cloud Build pool.

Used in: ExecutionConfig

• string service_account = 1

  Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) will be used.

• string artifact_storage = 2

  Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.

A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress.

Used in: DeliveryPipelineEventData, Release

• string name = 1

  Optional. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/[a-z][a-z0-9\-]{0,62}`.

• string uid = 2

  Output only. Unique identifier of the `DeliveryPipeline`.

• string description = 3

  Description of the `DeliveryPipeline`. Max length is 255 characters.

• map<string, string> annotations = 4

  User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy.

• map<string, string> labels = 5

  Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

• optional protobuf.Timestamp create_time = 6

  Output only. Time at which the pipeline was created.

• optional protobuf.Timestamp update_time = 7

  Output only. Most recent time at which the pipeline was updated.

• oneof pipeline

  The ordering configuration of the `DeliveryPipeline`.

  • SerialPipeline serial_pipeline = 8

    SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.

• optional PipelineCondition condition = 11

  Output only. Information around the state of the Delivery Pipeline.

• string etag = 10

  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.

• bool suspended = 12

  When suspended, no new releases or rollouts can be created, but in-progress ones will complete.

The CloudEvent raised when a DeliveryPipeline is created.

• optional DeliveryPipelineEventData data = 1

  The data associated with the event.

The CloudEvent raised when a DeliveryPipeline is deleted.

• optional DeliveryPipelineEventData data = 1

  The data associated with the event.

The data within all DeliveryPipeline events.

Used in: DeliveryPipelineCreatedEvent, DeliveryPipelineDeletedEvent, DeliveryPipelineUpdatedEvent

• optional DeliveryPipeline payload = 1

  Optional. The DeliveryPipeline event payload. Unset for deletion events.

The CloudEvent raised when a DeliveryPipeline is updated.

• optional DeliveryPipelineEventData data = 1

  The data associated with the event.

A deploy Job.

Used in: Job

(message has no fields)

DeployParameters contains deploy parameters information.

Used in: Stage

• map<string, string> values = 1

  Required. Values are deploy parameters in key-value pairs.

• map<string, string> match_target_labels = 2

  Optional. Deploy parameters are applied to targets with match labels. If unspecified, deploy parameters are applied to all targets (including child targets of a multi-target).

Deployment job composition.

Used in: Phase

• optional Job deploy_job = 1

  Output only. The deploy Job. This is the deploy job in the phase.

• optional Job verify_job = 2

  Output only. The verify Job. Runs after a deploy if the deploy succeeds.

• optional Job predeploy_job = 3

  Output only. The predeploy Job, which is the first job on the phase.

• optional Job postdeploy_job = 4

  Output only. The postdeploy Job, which is the last job on the phase.

Configuration of the environment to use when calling Skaffold.

Used in: Target

• repeated ExecutionConfig.ExecutionEnvironmentUsage usages = 1

  Required. Usages when this configuration should be applied.

• oneof execution_environment

  Details of the environment.

  • DefaultPool default_pool = 2

    Optional. Use default Cloud Build pool.

  • PrivatePool private_pool = 3

    Optional. Use private Cloud Build pool.

• string worker_pool = 4

  Optional. The resource name of the `WorkerPool`, with the format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. If this optional field is unspecified, the default Cloud Build pool will be used.

• string service_account = 5

  Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) is used.

• string artifact_storage = 6

  Optional. Cloud Storage location in which to store execution outputs. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.

• optional protobuf.Duration execution_timeout = 7

  Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and 24h in seconds format. If unspecified, a default timeout of 1h is used.

Possible usages of this configuration.

Used in: ExecutionConfig

• EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED = 0

  Default value. This value is unused.

• RENDER = 1

  Use for rendering.

• DEPLOY = 2

  Use for deploying and deployment hooks.

• VERIFY = 3

  Use for deployment verification.

• PREDEPLOY = 4

  Use for predeploy job execution.

• POSTDEPLOY = 5

  Use for postdeploy job execution.

Information specifying a GKE Cluster.

Used in: Target

• string cluster = 1

  Information specifying a GKE Cluster. Format is `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`.

• bool internal_ip = 2

  Optional. If true, `cluster` is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept).

Job represents an operation for a `Rollout`.

Used in: ChildRolloutJobs, DeploymentJobs

• string id = 1

  Output only. The ID of the Job.

• Job.State state = 2

  Output only. The current state of the Job.

• string skip_message = 8

  Output only. Additional information on why the Job was skipped, if available.

• string job_run = 3

  Output only. The name of the `JobRun` responsible for the most recent invocation of this Job.

• oneof job_type

  The type of Job.

  • DeployJob deploy_job = 4

    Output only. A deploy Job.

  • VerifyJob verify_job = 5

    Output only. A verify Job.

  • PredeployJob predeploy_job = 9

    Output only. A predeploy Job.

  • PostdeployJob postdeploy_job = 10

    Output only. A postdeploy Job.

  • CreateChildRolloutJob create_child_rollout_job = 6

    Output only. A createChildRollout Job.

  • AdvanceChildRolloutJob advance_child_rollout_job = 7

    Output only. An advanceChildRollout Job.

Valid states of a Job.

Used in: Job

• STATE_UNSPECIFIED = 0

  The Job has an unspecified state.

• PENDING = 1

  The Job is waiting for an earlier Phase(s) or Job(s) to complete.

• DISABLED = 2

  The Job is disabled.

• IN_PROGRESS = 3

  The Job is in progress.

• SUCCEEDED = 4

  The Job succeeded.

• FAILED = 5

  The Job failed.

• ABORTED = 6

  The Job was aborted.

• SKIPPED = 7

  The Job was skipped.

• IGNORED = 8

  The Job was ignored.

KubernetesConfig contains the Kubernetes runtime configuration.

Used in: RuntimeConfig

• oneof service_definition

  The service definition configuration.

  • KubernetesConfig.GatewayServiceMesh gateway_service_mesh = 1

    Kubernetes Gateway API service mesh configuration.

  • KubernetesConfig.ServiceNetworking service_networking = 2

    Kubernetes Service networking configuration.

Information about the Kubernetes Gateway API service mesh configuration.

Used in: KubernetesConfig

• string http_route = 1

  Required. Name of the Gateway API HTTPRoute.

• string service = 2

  Required. Name of the Kubernetes Service.

• string deployment = 3

  Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.

• optional protobuf.Duration route_update_wait_time = 4

  Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.

• optional protobuf.Duration stable_cutback_duration = 5

  Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time.

Information about the Kubernetes Service networking configuration.

Used in: KubernetesConfig

• string service = 1

  Required. Name of the Kubernetes Service.

• string deployment = 2

  Required. Name of the Kubernetes Deployment whose traffic is managed by the specified Service.

• bool disable_pod_overprovisioning = 3

  Optional. Whether to disable Pod overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy will limit the number of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster.

Metadata includes information associated with a `Rollout`.

Used in: Rollout

• optional CloudRunMetadata cloud_run = 1

  Output only. The name of the Cloud Run Service that is associated with a `Rollout`.

• optional AutomationRolloutMetadata automation = 2

  Output only. AutomationRolloutMetadata contains the information about the interactions between Automation service and this rollout.

• optional CustomMetadata custom = 3

  Output only. Custom metadata provided by user-defined `Rollout` operations.

Information specifying a multiTarget.

Used in: Target

• repeated string target_ids = 1

  Required. The target_ids of this multiTarget.

Phase represents a collection of jobs that are logically grouped together for a `Rollout`.

Used in: Rollout

• string id = 1

  Output only. The ID of the Phase.

• Phase.State state = 3

  Output only. Current state of the Phase.

• string skip_message = 6

  Output only. Additional information on why the Phase was skipped, if available.

• oneof jobs

  The job composition of this Phase.

  • DeploymentJobs deployment_jobs = 4

    Output only. Deployment job composition.

  • ChildRolloutJobs child_rollout_jobs = 5

    Output only. ChildRollout job composition.

Valid states of a Phase.

Used in: Phase

• STATE_UNSPECIFIED = 0

  The Phase has an unspecified state.

• PENDING = 1

  The Phase is waiting for an earlier Phase(s) to complete.

• IN_PROGRESS = 2

  The Phase is in progress.

• SUCCEEDED = 3

  The Phase has succeeded.

• FAILED = 4

  The Phase has failed.

• ABORTED = 5

  The Phase was aborted.

• SKIPPED = 6

  The Phase was skipped.

PipelineCondition contains all conditions relevant to a Delivery Pipeline.

Used in: DeliveryPipeline

• optional PipelineReadyCondition pipeline_ready_condition = 1

  Details around the Pipeline's overall status.

• optional TargetsPresentCondition targets_present_condition = 3

  Details around targets enumerated in the pipeline.

• optional TargetsTypeCondition targets_type_condition = 4

  Details on the whether the targets enumerated in the pipeline are of the same type.

PipelineReadyCondition contains information around the status of the Pipeline.

Used in: PipelineCondition

• bool status = 3

  True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

• optional protobuf.Timestamp update_time = 4

  Last time the condition was updated.

Postdeploy contains the postdeploy job configuration information.

Used in: CanaryDeployment, CustomCanaryDeployment.PhaseConfig, Standard

• repeated string actions = 1

  Optional. A sequence of Skaffold custom actions to invoke during execution of the postdeploy job.

A postdeploy Job.

Used in: Job

• repeated string actions = 1

  Output only. The custom actions that the postdeploy Job executes.

Predeploy contains the predeploy job configuration information.

Used in: CanaryDeployment, CustomCanaryDeployment.PhaseConfig, Standard

• repeated string actions = 1

  Optional. A sequence of Skaffold custom actions to invoke during execution of the predeploy job.

A predeploy Job.

Used in: Job

• repeated string actions = 1

  Output only. The custom actions that the predeploy Job executes.

Execution using a private Cloud Build pool.

Used in: ExecutionConfig

• string worker_pool = 1

  Required. Resource name of the Cloud Build worker pool to use. The format is `projects/{project}/locations/{location}/workerPools/{pool}`.

• string service_account = 2

  Optional. Google service account to use for execution. If unspecified, the project execution service account (<PROJECT_NUMBER>-compute@developer.gserviceaccount.com) will be used.

• string artifact_storage = 3

  Optional. Cloud Storage location where execution outputs should be stored. This can either be a bucket ("gs://my-bucket") or a path within a bucket ("gs://my-bucket/my-dir"). If unspecified, a default bucket located in the same region will be used.

`PromoteRelease` rule will automatically promote a release from the current target to a specified target.

Used in: AutomationRule

• string id = 1

  Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z][a-z0-9\-]{0,62}`.

• optional protobuf.Duration wait = 2

  Optional. How long the release need to be paused until being promoted to the next target.

• string destination_target_id = 7

  Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * "@next", the next target in the promotion sequence.

• optional AutomationRuleCondition condition = 5

  Output only. Information around the state of the Automation rule.

• string destination_phase = 8

  Optional. The starting phase of the rollout created by this operation. Default to the first phase.

A `Release` resource in the Cloud Deploy API. A `Release` defines a specific Skaffold configuration instance that can be deployed.

Used in: ReleaseEventData

• string name = 1

  Optional. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/[a-z][a-z0-9\-]{0,62}`.

• string uid = 2

  Output only. Unique identifier of the `Release`.

• string description = 3

  Description of the `Release`. Max length is 255 characters.

• map<string, string> annotations = 4

  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 for more details such as format and size limitations.

• map<string, string> labels = 5

  Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

• bool abandoned = 23

  Output only. Indicates whether this is an abandoned release.

• optional protobuf.Timestamp create_time = 6

  Output only. Time at which the `Release` was created.

• optional protobuf.Timestamp render_start_time = 7

  Output only. Time at which the render began.

• optional protobuf.Timestamp render_end_time = 8

  Output only. Time at which the render completed.

• string skaffold_config_uri = 17

  Cloud Storage URI of tar.gz archive containing Skaffold configuration.

• string skaffold_config_path = 9

  Filepath of the Skaffold config inside of the config URI.

• repeated BuildArtifact build_artifacts = 10

  List of artifacts to pass through to Skaffold command.

• optional DeliveryPipeline delivery_pipeline_snapshot = 11

  Output only. Snapshot of the parent pipeline taken at release creation time.

• repeated Target target_snapshots = 12

  Output only. Snapshot of the targets taken at release creation time.

• repeated CustomTargetType custom_target_type_snapshots = 27

  Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.

• Release.RenderState render_state = 13

  Output only. Current state of the render operation.

• string etag = 16

  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.

• string skaffold_version = 19

  The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.

• map<string, TargetArtifact> target_artifacts = 20

  Output only. Map from target ID to the target artifacts created during the render operation.

• map<string, Release.TargetRender> target_renders = 22

  Output only. Map from target ID to details of the render operation for that target.

• optional Release.ReleaseCondition condition = 24

  Output only. Information around the state of the Release.

• map<string, string> deploy_parameters = 25

  Optional. The deploy parameters to use for all targets in this release.

ReleaseCondition contains all conditions relevant to a Release.

Used in: Release

• optional ReleaseReadyCondition release_ready_condition = 1

  Details around the Releases's overall status.

• optional SkaffoldSupportedCondition skaffold_supported_condition = 2

  Details around the support state of the release's Skaffold version.

ReleaseReadyCondition contains information around the status of the Release. If a release is not ready, you cannot create a rollout with the release.

Used in: ReleaseCondition

• bool status = 1

  True if the Release is in a valid state. Otherwise at least one condition in `ReleaseCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Release.

Valid states of the render operation.

Used in: Release

• RENDER_STATE_UNSPECIFIED = 0

  The render state is unspecified.

• SUCCEEDED = 1

  All rendering operations have completed successfully.

• FAILED = 2

  All rendering operations have completed, and one or more have failed.

• IN_PROGRESS = 3

  Rendering has started and is not complete.

SkaffoldSupportedCondition contains information about when support for the release's version of Skaffold ends.

Used in: ReleaseCondition

• bool status = 1

  True if the version of Skaffold used by this release is supported.

• SkaffoldSupportState skaffold_support_state = 2

  The Skaffold support state for this release's version of Skaffold.

• optional protobuf.Timestamp maintenance_mode_time = 3

  The time at which this release's version of Skaffold will enter maintenance mode.

• optional protobuf.Timestamp support_expiration_time = 4

  The time at which this release's version of Skaffold will no longer be supported.

Details of rendering for a single target.

Used in: Release

• string rendering_build = 1

  Output only. The resource name of the Cloud Build `Build` object that is used to render the manifest for this target. Format is `projects/{project}/locations/{location}/builds/{build}`.

• TargetRender.TargetRenderState rendering_state = 2

  Output only. Current state of the render operation for this Target.

• optional RenderMetadata metadata = 6

  Output only. Metadata related to the `Release` render for this Target.

• TargetRender.FailureCause failure_cause = 4

  Output only. Reason this render failed. This will always be unspecified while the render in progress.

• string failure_message = 5

  Output only. Additional information about the render failure, if available.

Well-known rendering failures.

Used in: TargetRender

• FAILURE_CAUSE_UNSPECIFIED = 0

  No reason for failure is specified.

• CLOUD_BUILD_UNAVAILABLE = 1

  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 = 2

  The render operation did not complete successfully; check Cloud Build logs.

• CLOUD_BUILD_REQUEST_FAILED = 3

  Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.

• VERIFICATION_CONFIG_NOT_FOUND = 4

  The render operation did not complete successfully because the verification stanza required for verify was not found on the Skaffold configuration.

• CUSTOM_ACTION_NOT_FOUND = 5

  The render operation did not complete successfully because the custom action required for predeploy or postdeploy was not found in the Skaffold configuration. See failure_message for additional details.

• DEPLOYMENT_STRATEGY_NOT_SUPPORTED = 6

  Release failed during rendering because the release configuration is not supported with the specified deployment strategy.

• RENDER_FEATURE_NOT_SUPPORTED = 7

  The render operation had a feature configured that is not supported.

Valid states of the render operation.

Used in: TargetRender

• TARGET_RENDER_STATE_UNSPECIFIED = 0

  The render operation state is unspecified.

• SUCCEEDED = 1

  The render operation has completed successfully.

• FAILED = 2

  The render operation has failed.

• IN_PROGRESS = 3

  The render operation is in progress.

The CloudEvent raised when a Release is created.

• optional ReleaseEventData data = 1

  The data associated with the event.

The data within all Release events.

Used in: ReleaseCreatedEvent

• optional Release payload = 1

  The Release event payload.

RenderMetadata includes information associated with a `Release` render.

Used in: Release.TargetRender

• optional CloudRunRenderMetadata cloud_run = 1

  Output only. Metadata associated with rendering for Cloud Run.

• optional CustomMetadata custom = 2

  Output only. Custom metadata provided by user-defined render operation.

Configuration of the repair action.

Used in: RepairRolloutRule

• oneof mode

  The repair action to perform.

  • Retry retry = 1

    Optional. Retries a failed job.

  • Rollback rollback = 2

    Optional. Rolls back a `Rollout`.

The `RepairRolloutRule` automation rule will automatically repair a failed `Rollout`.

Used in: AutomationRule

• string id = 1

  Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z][a-z0-9\-]{0,62}`.

• repeated string source_phases = 2

  Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.

• repeated string jobs = 3

  Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in `source_phase`. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.

• repeated RepairMode repair_modes = 4

  Required. Defines the types of automatic repair actions for failed jobs.

• optional AutomationRuleCondition condition = 6

  Output only. Information around the state of the 'Automation' rule.

Retries the failed job.

Used in: RepairMode

• int64 attempts = 1

  Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.

• optional protobuf.Duration wait = 2

  Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.

• BackoffMode backoff_mode = 3

  Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.

Rolls back a `Rollout`.

Used in: RepairMode

• string destination_phase = 1

  Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.

A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.

Used in: RolloutEventData

• string name = 1

  Optional. Name of the `Rollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}`.

• string uid = 2

  Output only. Unique identifier of the `Rollout`.

• string description = 3

  Description of the `Rollout` for user purposes. Max length is 255 characters.

• map<string, string> annotations = 4

  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 for more details such as format and size limitations.

• map<string, string> labels = 5

  Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

• optional protobuf.Timestamp create_time = 6

  Output only. Time at which the `Rollout` was created.

• optional protobuf.Timestamp approve_time = 7

  Output only. Time at which the `Rollout` was approved.

• optional protobuf.Timestamp enqueue_time = 8

  Output only. Time at which the `Rollout` was enqueued.

• optional protobuf.Timestamp deploy_start_time = 9

  Output only. Time at which the `Rollout` started deploying.

• optional protobuf.Timestamp deploy_end_time = 10

  Output only. Time at which the `Rollout` finished deploying.

• string target_id = 18

  Required. The ID of Target to which this `Rollout` is deploying.

• Rollout.ApprovalState approval_state = 12

  Output only. Approval state of the `Rollout`.

• Rollout.State state = 13

  Output only. Current state of the `Rollout`.

• string failure_reason = 14

  Output only. Additional information about the rollout failure, if available.

• string deploying_build = 17

  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}`.

• string etag = 16

  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.

• Rollout.FailureCause deploy_failure_cause = 19

  Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress.

• repeated Phase phases = 23

  Output only. The phases that represent the workflows of this `Rollout`.

• optional Metadata metadata = 24

  Output only. Metadata contains information about the rollout.

• string controller_rollout = 25

  Output only. Name of the `ControllerRollout`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}`.

• string rollback_of_rollout = 26

  Output only. Name of the `Rollout` that is rolled back by this `Rollout`. Empty if this `Rollout` wasn't created as a rollback.

• repeated string rolled_back_by_rollouts = 27

  Output only. Names of `Rollouts` that rolled back this `Rollout`.

Valid approval states of a `Rollout`.

Used in: Rollout

• APPROVAL_STATE_UNSPECIFIED = 0

  The `Rollout` has an unspecified approval state.

• NEEDS_APPROVAL = 1

  The `Rollout` requires approval.

• DOES_NOT_NEED_APPROVAL = 2

  The `Rollout` does not require approval.

• APPROVED = 3

  The `Rollout` has been approved.

• REJECTED = 4

  The `Rollout` has been rejected.

Well-known rollout failures.

Used in: Rollout

• FAILURE_CAUSE_UNSPECIFIED = 0

  No reason for failure is specified.

• CLOUD_BUILD_UNAVAILABLE = 1

  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 = 2

  The deploy operation did not complete successfully; check Cloud Build logs.

• DEADLINE_EXCEEDED = 3

  Deployment did not complete within the alloted time.

• RELEASE_FAILED = 4

  Release is in a failed state.

• RELEASE_ABANDONED = 5

  Release is abandoned.

• VERIFICATION_CONFIG_NOT_FOUND = 6

  No Skaffold verify configuration was found.

• CLOUD_BUILD_REQUEST_FAILED = 7

  Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.

• OPERATION_FEATURE_NOT_SUPPORTED = 8

  A Rollout operation had a feature configured that is not supported.

Valid states of a `Rollout`.

Used in: Rollout

• STATE_UNSPECIFIED = 0

  The `Rollout` has an unspecified state.

• SUCCEEDED = 1

  The `Rollout` has completed successfully.

• FAILED = 2

  The `Rollout` has failed.

• IN_PROGRESS = 3

  The `Rollout` is being deployed.

• PENDING_APPROVAL = 4

  The `Rollout` needs approval.

• APPROVAL_REJECTED = 5

  An approver rejected the `Rollout`.

• PENDING = 6

  The `Rollout` is waiting for an earlier Rollout(s) to complete on this `Target`.

• PENDING_RELEASE = 7

  The `Rollout` is waiting for the `Release` to be fully rendered.

• CANCELLING = 8

  The `Rollout` is in the process of being cancelled.

• CANCELLED = 9

  The `Rollout` has been cancelled.

• HALTED = 10

  The `Rollout` is halted.

The CloudEvent raised when a Rollout is created.

• optional RolloutEventData data = 1

  The data associated with the event.

The data within all Rollout events.

Used in: RolloutCreatedEvent

• optional Rollout payload = 1

  The Rollout event payload.

RuntimeConfig contains the runtime specific configurations for a deployment strategy.

Used in: Canary

• oneof runtime_config

  The runtime configuration details.

  • KubernetesConfig kubernetes = 1

    Kubernetes runtime configuration.

  • CloudRunConfig cloud_run = 2

    Cloud Run runtime configuration.

SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.

Used in: DeliveryPipeline

• repeated Stage stages = 1

  Each stage specifies configuration for a `Target`. The ordering of this list defines the promotion flow.

Skaffold Config modules and their remote source.

Used in: CustomTargetSkaffoldActions

• repeated string configs = 1

  Optional. The Skaffold Config modules to use from the specified source.

• oneof source

  The source that contains the Skaffold Config modules.

  • SkaffoldModules.SkaffoldGitSource git = 2

    Remote git repository containing the Skaffold Config modules.

  • SkaffoldModules.SkaffoldGCSSource google_cloud_storage = 3

    Cloud Storage bucket containing the Skaffold Config modules.

Cloud Storage bucket containing Skaffold Config modules.

Used in: SkaffoldModules

• string source = 1

  Required. Cloud Storage source paths to copy recursively. For example, providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying all files within the "dir/configs" directory in the bucket "my-bucket".

• string path = 2

  Optional. Relative path from the source to the Skaffold file.

Git repository containing Skaffold Config modules.

Used in: SkaffoldModules

• string repo = 1

  Required. Git repository the package should be cloned from.

• string path = 2

  Optional. Relative path from the repository root to the Skaffold file.

• string ref = 3

  Optional. Git ref the package should be cloned from.

The support state of a specific Skaffold version.

Used in: Release.SkaffoldSupportedCondition

• SKAFFOLD_SUPPORT_STATE_UNSPECIFIED = 0

  Default value. This value is unused.

• SKAFFOLD_SUPPORT_STATE_SUPPORTED = 1

  This Skaffold version is currently supported.

• SKAFFOLD_SUPPORT_STATE_MAINTENANCE_MODE = 2

  This Skaffold version is in maintenance mode.

• SKAFFOLD_SUPPORT_STATE_UNSUPPORTED = 3

  This Skaffold version is no longer supported.

Stage specifies a location to which to deploy.

Used in: SerialPipeline

• string target_id = 1

  The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be `my-target` (rather than `projects/project/locations/location/targets/my-target`). The location of the `Target` is inferred to be the same as the location of the `DeliveryPipeline` that contains this `Stage`.

• repeated string profiles = 2

  Skaffold profiles to use when rendering the manifest for this stage's `Target`.

• optional Strategy strategy = 5

  Optional. The strategy to use for a `Rollout` to this stage.

• repeated DeployParameters deploy_parameters = 6

  Optional. The deploy parameters to use for the target in this stage.

Standard represents the standard deployment strategy.

Used in: Strategy

• bool verify = 1

  Whether to verify a deployment.

• optional Predeploy predeploy = 2

  Optional. Configuration for the predeploy job. If this is not configured, predeploy job will not be present.

• optional Postdeploy postdeploy = 3

  Optional. Configuration for the postdeploy job. If this is not configured, postdeploy job will not be present.

Strategy contains deployment strategy information.

Used in: Stage

• oneof deployment_strategy

  Deployment strategy details.

  • Standard standard = 1

    Standard deployment strategy executes a single deploy and allows verifying the deployment.

  • Canary canary = 2

    Canary deployment strategy provides progressive percentage based deployments to a Target.

A `Target` resource in the Cloud Deploy API. A `Target` defines a location to which a Skaffold configuration can be deployed.

Used in: Release, TargetEventData

• string name = 1

  Optional. Name of the `Target`. Format is `projects/{project}/locations/{location}/targets/[a-z][a-z0-9\-]{0,62}`.

• string target_id = 2

  Output only. Resource id of the `Target`.

• string uid = 3

  Output only. Unique identifier of the `Target`.

• string description = 4

  Optional. Description of the `Target`. Max length is 255 characters.

• map<string, string> annotations = 5

  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 for more details such as format and size limitations.

• map<string, string> labels = 6

  Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

• bool require_approval = 13

  Optional. Whether or not the `Target` requires approval.

• optional protobuf.Timestamp create_time = 8

  Output only. Time at which the `Target` was created.

• optional protobuf.Timestamp update_time = 9

  Output only. Most recent time at which the `Target` was updated.

• oneof deployment_target

  Destination to which the Skaffold configuration is applied during a rollout.

  • GkeCluster gke = 15

    Optional. Information specifying a GKE Cluster.

  • AnthosCluster anthos_cluster = 17

    Optional. Information specifying an Anthos Cluster.

  • CloudRunLocation run = 18

    Optional. Information specifying a Cloud Run deployment target.

  • MultiTarget multi_target = 19

    Optional. Information specifying a multiTarget.

  • CustomTarget custom_target = 21

    Optional. Information specifying a Custom Target.

• string etag = 12

  Optional. 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.

• repeated ExecutionConfig execution_configs = 16

  Configurations for all execution that relates to this `Target`. Each `ExecutionEnvironmentUsage` value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values. When no configurations are specified, execution will use the default specified in `DefaultPool`.

• map<string, string> deploy_parameters = 20

  Optional. The deploy parameters to use for this target.

The artifacts produced by a target render operation.

Used in: Release

• oneof uri

  • string artifact_uri = 4

    Output only. URI of a directory containing the artifacts. This contains deployment configuration used by Skaffold during a rollout, and all paths are relative to this location.

• string skaffold_config_path = 2

  Output only. File path of the resolved Skaffold configuration relative to the URI.

• string manifest_path = 3

  Output only. File path of the rendered manifest relative to the URI.

• map<string, TargetArtifact.PhaseArtifact> phase_artifacts = 5

  Output only. Map from the phase ID to the phase artifacts for the `Target`.

Contains the paths to the artifacts, relative to the URI, for a phase.

Used in: TargetArtifact

• string skaffold_config_path = 1

  Output only. File path of the resolved Skaffold configuration relative to the URI.

• string manifest_path = 3

  Output only. File path of the rendered manifest relative to the URI.

• string job_manifests_path = 4

  Output only. File path of the directory of rendered job manifests relative to the URI. This is only set if it is applicable.

Contains criteria for selecting Targets.

Used in: AutomationResourceSelector

• string id = 1

  ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * "*", all targets in a location.

• map<string, string> labels = 2

  Target labels.

The CloudEvent raised when a Target is created.

• optional TargetEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Target is deleted.

• optional TargetEventData data = 1

  The data associated with the event.

The data within all Target events.

Used in: TargetCreatedEvent, TargetDeletedEvent, TargetUpdatedEvent

• optional Target payload = 1

  Optional. The Target event payload. Unset for deletion events.

The CloudEvent raised when a Target is updated.

• optional TargetEventData data = 1

  The data associated with the event.

`TargetsPresentCondition` contains information on any Targets referenced in the Delivery Pipeline that do not actually exist.

Used in: AutomationRuleCondition, PipelineCondition

• bool status = 1

  True if there aren't any missing Targets.

• repeated string missing_targets = 2

  The list of Target names that do not exist. For example, `projects/{project_id}/locations/{location_name}/targets/{target_name}`.

• optional protobuf.Timestamp update_time = 4

  Last time the condition was updated.

TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type.

Used in: PipelineCondition

• bool status = 1

  True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters.

• string error_details = 2

  Human readable error message.

A verify Job.

Used in: Job

(message has no fields)