@swamp/gcp/clouddeploy
v2026.04.23.1
Google Cloud clouddeploy infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudclouddeploycloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/clouddeploy@swamp/gcp/clouddeploy/customtargettypesv2026.04.23.1customtargettypes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | 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. |
| customActions? | object | CustomTargetSkaffoldActions represents the `CustomTargetType` configuration using Skaffold custom actions. |
| description? | string | Optional. Description of the `CustomTargetType`. Max length is 255 characters. |
| labels? | record | 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 b |
| name? | string | Identifier. Name of the `CustomTargetType`. Format is `projects/{project}/locations/{location}/customTargetTypes/{customTargetType}`. The `customTargetType` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` |
| tasks? | object | CustomTargetTasks represents the `CustomTargetType` configuration using tasks. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and i |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a customTargetTypes
getGet a customTargetTypes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customTargetTypes |
updateUpdate customTargetTypes attributes
deleteDelete the customTargetTypes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customTargetTypes |
syncSync customTargetTypes state from GCP
Resources
state(infinite)— A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` d...
@swamp/gcp/clouddeploy/deliverypipelinesv2026.04.23.1deliverypipelines.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. |
| condition? | object | PipelineCondition contains all conditions relevant to a Delivery Pipeline. |
| description? | string | Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. |
| labels? | record | 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 b |
| name? | string | Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` |
| serialPipeline? | object | SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. |
| suspended? | boolean | Optional. When suspended, no new releases or rollouts can be created, but in-progress ones will complete. |
| deliveryPipelineId? | string | Required. ID of the `DeliveryPipeline`. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and i |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a deliveryPipelines
getGet a deliveryPipelines
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deliveryPipelines |
updateUpdate deliveryPipelines attributes
deleteDelete the deliveryPipelines
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deliveryPipelines |
syncSync deliveryPipelines state from GCP
rollback_targetrollback target
| Argument | Type | Description |
|---|---|---|
| overrideDeployPolicy? | any | |
| releaseId? | any | |
| rollbackConfig? | any | |
| rolloutId? | any | |
| rolloutToRollBack? | any | |
| targetId? | any | |
| validateOnly? | any |
Resources
state(infinite)— A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` d...
@swamp/gcp/clouddeploy/deliverypipelines-automationrunsv2026.04.23.1deliverypipelines_automationruns.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a automationRuns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the automationRuns |
syncSync automationRuns state from GCP
cancelcancel
Resources
state(infinite)— An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` repre...
@swamp/gcp/clouddeploy/deliverypipelines-automationsv2026.04.23.1deliverypipelines_automations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| annotations? | record | 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 betwee |
| description? | string | Optional. Description of the `Automation`. Max length is 255 characters. |
| labels? | record | 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 b |
| rules? | array | 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. |
| selector? | object | AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. |
| serviceAccount? | string | Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources. |
| suspended? | boolean | Optional. When Suspended, automation is deactivated from execution. |
| automationId? | string | Required. ID of the `Automation`. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and i |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a automations
getGet a automations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the automations |
updateUpdate automations attributes
deleteDelete the automations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the automations |
syncSync automations state from GCP
Resources
state(infinite)— An `Automation` resource in the Cloud Deploy API. An `Automation` enables the...
@swamp/gcp/clouddeploy/deliverypipelines-releasesv2026.04.23.1deliverypipelines_releases.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | 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. |
| buildArtifacts? | array | Optional. List of artifacts to pass through to Skaffold command. |
| condition? | object | ReleaseCondition contains all conditions relevant to a Release. |
| deliveryPipelineSnapshot? | object | A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. |
| deployParameters? | record | Optional. The deploy parameters to use for all targets in this release. |
| description? | string | Optional. Description of the `Release`. Max length is 255 characters. |
| labels? | record | 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 b |
| name? | string | Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` |
| skaffoldConfigPath? | string | Optional. Filepath of the Skaffold config inside of the config URI. |
| skaffoldConfigUri? | string | Optional. Cloud Storage URI of tar.gz archive containing Skaffold configuration. |
| skaffoldVersion? | string | Optional. 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. |
| toolVersions? | object | Details of ToolVersions for the release. |
| overrideDeployPolicy? | string | Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`. |
| releaseId? | string | Required. ID of the `Release`. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and i |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a releases
getGet a releases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the releases |
syncSync releases state from GCP
abandonabandon
Resources
state(infinite)— A `Release` resource in the Cloud Deploy API. A `Release` defines a specific ...
@swamp/gcp/clouddeploy/deliverypipelines-releases-rolloutsv2026.04.23.1deliverypipelines_releases_rollouts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | 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. |
| description? | string | Optional. Description of the `Rollout` for user purposes. Max length is 255 characters. |
| labels? | record | 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 b |
| metadata? | object | Metadata includes information associated with a `Rollout`. |
| name? | string | 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])?` |
| targetId? | string | Required. The ID of Target to which this `Rollout` is deploying. |
| overrideDeployPolicy? | string | Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and i |
| rolloutId? | string | Required. ID of the `Rollout`. |
| startingPhaseId? | string | Optional. The starting phase ID for the `Rollout`. If empty the `Rollout` will start at the first phase. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a rollouts
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a rollouts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the rollouts |
syncSync rollouts state from GCP
advanceadvance
| Argument | Type | Description |
|---|---|---|
| overrideDeployPolicy? | any | |
| phaseId? | any |
approveapprove
| Argument | Type | Description |
|---|---|---|
| approved? | any | |
| overrideDeployPolicy? | any |
cancelcancel
| Argument | Type | Description |
|---|---|---|
| overrideDeployPolicy? | any |
ignore_jobignore job
| Argument | Type | Description |
|---|---|---|
| jobId? | any | |
| overrideDeployPolicy? | any | |
| phaseId? | any |
retry_jobretry job
| Argument | Type | Description |
|---|---|---|
| jobId? | any | |
| overrideDeployPolicy? | any | |
| phaseId? | any |
Resources
state(infinite)— A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains informatio...
@swamp/gcp/clouddeploy/deliverypipelines-releases-rollouts-jobrunsv2026.04.23.1deliverypipelines_releases_rollouts_jobruns.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a jobRuns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the jobRuns |
syncSync jobRuns state from GCP
terminateterminate
| Argument | Type | Description |
|---|---|---|
| overrideDeployPolicy? | any |
Resources
state(infinite)— A `JobRun` resource in the Cloud Deploy API. A `JobRun` contains information ...
@swamp/gcp/clouddeploy/deploypoliciesv2026.04.23.1deploypolicies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| annotations? | record | 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 betwee |
| description? | string | Optional. Description of the `DeployPolicy`. Max length is 255 characters. |
| labels? | record | 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 b |
| rules? | array | Required. Rules to apply. At least one rule must be present. |
| selectors? | array | Required. Selected resources to which the policy will be applied. At least one selector is required. If one selector matches the resource the policy applies. For example, if there are two selectors and the action being attempted matches one of them, the policy will apply to that action. |
| suspended? | boolean | Optional. When suspended, the policy will not prevent actions from occurring, even if the action violates the policy. |
| deployPolicyId? | string | Required. ID of the `DeployPolicy`. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and i |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a deployPolicies
getGet a deployPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployPolicies |
updateUpdate deployPolicies attributes
deleteDelete the deployPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployPolicies |
syncSync deployPolicies state from GCP
Resources
state(infinite)— A `DeployPolicy` resource in the Cloud Deploy API. A `DeployPolicy` inhibits ...
@swamp/gcp/clouddeploy/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
syncSync locations state from GCP
get_configget config
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/clouddeploy/targetsv2026.04.23.1targets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | 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. |
| anthosCluster? | object | Information specifying an Anthos Cluster. |
| associatedEntities? | record | Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID 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, |
| customTarget? | object | Information specifying a Custom Target. |
| deployParameters? | record | Optional. The deploy parameters to use for this target. |
| description? | string | Optional. Description of the `Target`. Max length is 255 characters. |
| executionConfigs? | array | Optional. 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`. |
| gke? | object | Information specifying a GKE Cluster. |
| labels? | record | 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 b |
| multiTarget? | object | Information specifying a multiTarget. |
| name? | string | Identifier. Name of the `Target`. Format is `projects/{project}/locations/{location}/targets/{target}`. The `target` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` |
| requireApproval? | boolean | Optional. Whether or not the `Target` requires approval. |
| run? | object | Information specifying where to deploy a Cloud Run Service. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and i |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a targets
getGet a targets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targets |
updateUpdate targets attributes
deleteDelete the targets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targets |
syncSync targets state from GCP
Resources
state(infinite)— A `Target` resource in the Cloud Deploy API. A `Target` defines a location to...
2026.04.04.182.4 KBApr 4, 2026
Google Cloud clouddeploy infrastructure models
Release Notes
- Updated: deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudclouddeploycloudinfrastructure
2026.04.03.3120.8 KBApr 3, 2026
Google Cloud clouddeploy infrastructure models
Release Notes
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudclouddeploycloudinfrastructure
2026.04.03.1119.8 KBApr 3, 2026
Google Cloud clouddeploy infrastructure models
Release Notes
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudclouddeploycloudinfrastructure
2026.04.02.2119.8 KBApr 2, 2026
Google Cloud clouddeploy infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudclouddeploycloudinfrastructure
2026.03.27.1120.3 KBMar 27, 2026
Google Cloud clouddeploy infrastructure models
Release Notes
- Added: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudclouddeploycloudinfrastructure