Gcp/clouddeploy
@swamp/gcp/clouddeployv2026.10.13.1
01README
Google Cloud clouddeploy infrastructure models
02Release Notes
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
03Behaviors
@swamp/gcp/clouddeploy/customtargettypesv2026.10.13.1customtargettypes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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 | Optional. Configures render and deploy for the `CustomTargetType` 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 | Optional. Configures render and deploy for the `CustomTargetType` 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 |
| allowMissing? | string | Optional. If set to true, updating a `CustomTargetType` that does not exist will result in the creation of a new `CustomTargetType`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a customTargetTypes
fn get(identifier: string)
Get a customTargetTypes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customTargetTypes |
fn update(identifier?: string)
Update customTargetTypes attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customTargetTypes by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the customTargetTypes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customTargetTypes |
fn sync(identifier?: string)
Sync customTargetTypes state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customTargetTypes by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List customTargetTypes resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter custom target types to be returned. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. The maximum number of `CustomTargetType` objects to return. The service may return fewer than this value. If unspecified, at most 50 `CustomTargetType` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
Resources
state(infinite)— A `CustomTargetType` resource in the Cloud Deploy API. A `CustomTargetType` d...
@swamp/gcp/clouddeploy/deliverypipelinesv2026.10.13.1deliverypipelines.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| annotations? | record | Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. |
| description? | string | Optional. Description of the `DeliveryPipeline`. 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 `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 | Optional. 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 |
| allowMissing? | string | Optional. If set to true, updating a `DeliveryPipeline` that does not exist will result in the creation of a new `DeliveryPipeline`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a deliveryPipelines
fn get(identifier: string)
Get a deliveryPipelines
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deliveryPipelines |
fn update(identifier?: string)
Update deliveryPipelines attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deliveryPipelines by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the deliveryPipelines
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deliveryPipelines |
fn sync(identifier?: string)
Sync deliveryPipelines state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deliveryPipelines by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List deliveryPipelines resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter pipelines to be returned. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Field to sort by. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn rollback_target(overrideDeployPolicy?: any, releaseId?: any, rollbackConfig?: any, rolloutId?: any, rolloutToRollBack?: any, targetId?: any, validateOnly?: any)
rollback target
| Argument | Type | Description |
|---|---|---|
| overrideDeployPolicy? | any | |
| releaseId? | any | |
| rollbackConfig? | any | |
| rolloutId? | any | |
| rolloutToRollBack? | any | |
| targetId? | any | |
| validateOnly? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` d...
@swamp/gcp/clouddeploy/deliverypipelines-automationrunsv2026.10.13.1deliverypipelines_automationruns.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a automationRuns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the automationRuns |
fn sync(identifier?: string)
Sync automationRuns state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific automationRuns by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List automationRuns resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter automationRuns to be returned. All fields can be used in the filter. |
| orderBy? | string | Field to sort by. |
| pageSize? | number | The maximum number of automationRuns to return. The service may return fewer than this value. If unspecified, at most 50 automationRuns will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn cancel()
cancel
Resources
state(infinite)— An `AutomationRun` resource in the Cloud Deploy API. An `AutomationRun` repre...
@swamp/gcp/clouddeploy/deliverypipelines-automationsv2026.10.13.1deliverypipelines_automations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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 | Required. Selected resources to which the automation will 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 |
| allowMissing? | string | Optional. If set to true, updating a `Automation` that does not exist will result in the creation of a new `Automation`. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a automations
fn get(identifier: string)
Get a automations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the automations |
fn update(identifier?: string)
Update automations attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific automations by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the automations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the automations |
fn sync(identifier?: string)
Sync automations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific automations by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List automations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter automations to be returned. All fields can be used in the filter. |
| orderBy? | string | Field to sort by. |
| pageSize? | number | The maximum number of automations to return. The service may return fewer than this value. If unspecified, at most 50 automations will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An `Automation` resource in the Cloud Deploy API. An `Automation` enables the...
@swamp/gcp/clouddeploy/deliverypipelines-releasesv2026.10.13.1deliverypipelines_releases.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| 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 | 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 `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 | Optional. The tool versions to use for this release and all subsequent operations involving this release. If unset, tool versions are frozen when the release is created. |
| 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 |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a releases
fn get(identifier: string)
Get a releases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the releases |
fn sync(identifier?: string)
Sync releases state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific releases by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List releases resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter releases to be returned. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. The maximum number of `Release` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Release` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn abandon()
abandon
Resources
state(infinite)— A `Release` resource in the Cloud Deploy API. A `Release` defines a specific ...
@swamp/gcp/clouddeploy/deliverypipelines-releases-rolloutsv2026.10.13.1deliverypipelines_releases_rollouts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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 |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a rollouts
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a rollouts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the rollouts |
fn sync(identifier?: string)
Sync rollouts state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific rollouts by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List rollouts resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. The maximum number of `Rollout` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Rollout` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn advance(overrideDeployPolicy?: any, phaseId?: any)
advance
| Argument | Type | Description |
|---|---|---|
| overrideDeployPolicy? | any | |
| phaseId? | any |
fn approve(approved?: any, overrideDeployPolicy?: any)
approve
| Argument | Type | Description |
|---|---|---|
| approved? | any | |
| overrideDeployPolicy? | any |
fn cancel(overrideDeployPolicy?: any)
cancel
| Argument | Type | Description |
|---|---|---|
| overrideDeployPolicy? | any |
fn ignore_job(jobId?: any, overrideDeployPolicy?: any, phaseId?: any)
ignore job
| Argument | Type | Description |
|---|---|---|
| jobId? | any | |
| overrideDeployPolicy? | any | |
| phaseId? | any |
fn retry_job(jobId?: any, overrideDeployPolicy?: any, phaseId?: any)
retry 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.10.13.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) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a jobRuns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the jobRuns |
fn sync(identifier?: string)
Sync jobRuns state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific jobRuns by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List jobRuns resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter results to be returned. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. The maximum number of `JobRun` objects to return. The service may return fewer than this value. If unspecified, at most 50 `JobRun` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn terminate(overrideDeployPolicy?: any)
terminate
| Argument | Type | Description |
|---|---|---|
| overrideDeployPolicy? | any |
Resources
state(infinite)— A `JobRun` resource in the Cloud Deploy API. A `JobRun` contains information ...
@swamp/gcp/clouddeploy/deploypoliciesv2026.10.13.1deploypolicies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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 |
| allowMissing? | string | Optional. If set to true, updating a `DeployPolicy` that does not exist will result in the creation of a new `DeployPolicy`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a deployPolicies
fn get(identifier: string)
Get a deployPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployPolicies |
fn update(identifier?: string)
Update deployPolicies attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deployPolicies by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the deployPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployPolicies |
fn sync(identifier?: string)
Sync deployPolicies state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific deployPolicies by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List deployPolicies resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter. |
| orderBy? | string | Field to sort by. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | The maximum number of deploy policies to return. The service may return fewer than this value. If unspecified, at most 50 deploy policies will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
Resources
state(infinite)— A `DeployPolicy` resource in the Cloud Deploy API. A `DeployPolicy` inhibits ...
@swamp/gcp/clouddeploy/locationsv2026.10.13.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_config()
get config
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/clouddeploy/targetsv2026.10.13.1targets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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 | Optional. 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 | Optional. 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 | Optional. 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 | Optional. 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 | Optional. Information specifying a Cloud Run deployment target. |
| 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 |
| allowMissing? | string | Optional. If set to true, updating a `Target` that does not exist will result in the creation of a new `Target`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a targets
fn get(identifier: string)
Get a targets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targets |
fn update(identifier?: string)
Update targets attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific targets by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the targets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targets |
fn sync(identifier?: string)
Sync targets state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific targets by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List targets resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. The maximum number of `Target` objects to return. The service may return fewer than this value. If unspecified, at most 50 `Target` objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A `Target` resource in the Cloud Deploy API. A `Target` defines a location to...
04Previous Versions
2026.09.07.2
- Updated: customtargettypes, deliverypipelines, deploypolicies, targets
2026.08.12.2
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.07.29.1
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.07.21.4
- Updated: locations, deliverypipelines, deliverypipelines_releases
2026.07.21.1
- Updated: customtargettypes, deliverypipelines, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deploypolicies, targets
2026.07.20.2
- Updated: locations, deliverypipelines, deliverypipelines_releases
2026.07.20.1
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.07.18.2
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.07.17.2
- Updated: customtargettypes, deliverypipelines, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deploypolicies, targets
2026.07.17.1
- Updated: customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.06.08.2
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.06.07.1
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.05.26.1
- Updated: locations, deliverypipelines, deliverypipelines_releases
2026.05.25.1
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
Modified 10 behaviors
2026.05.24.1
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.05.21.2
- Updated: locations, customtargettypes, deliverypipelines, deliverypipelines_automationruns, deliverypipelines_automations, deliverypipelines_releases, deliverypipelines_releases_rollouts, deliverypipelines_releases_rollouts_jobruns, deploypolicies, targets
2026.05.21.1
Modified 4 behaviors
05Stats
A
93 / 100
Downloads
17
Archive size
142.5 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License1/2partial
no SPDX license declared
- Verified public repository2/2earned
06Platforms
07Labels