Gcp/cloudbuild
@swamp/gcp/cloudbuildv2026.10.13.1
01README
Google Cloud cloudbuild infrastructure models
02Release Notes
- Updated: locations, connections, connections_repositories, builds, githubenterpriseconfigs, bitbucketserverconfigs, bitbucketserverconfigs_repos, triggers, workerpools
03Behaviors
bitbucketserverconfigs.tsv2026.10.13.1
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. |
| apiKey? | string | Required. Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. |
| createTime? | string | Time when the config was created. |
| hostUri? | string | Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. |
| name? | string | Identifier. The resource name for the config. |
| peeredNetwork? | string | Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. |
| peeredNetworkIpRange? | string | Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. |
| secrets? | object | Required. The resource name for the admin access token's secret version. |
| sslCa? | string | Optional. SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of.pem,.cer, or.crt. |
| username? | string | Username of the account Cloud Build will use on Bitbucket Server. |
| bitbucketServerConfigId? | string | Optional. The ID to use for the BitbucketServerConfig, which will become the final component of the BitbucketServerConfig's resource name. bitbucket_server_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a bitbucketServerConfigs
fn get(identifier: string)
Get a bitbucketServerConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bitbucketServerConfigs |
fn update(identifier?: string)
Update bitbucketServerConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific bitbucketServerConfigs by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the bitbucketServerConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the bitbucketServerConfigs |
fn sync(identifier?: string)
Sync bitbucketServerConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific bitbucketServerConfigs by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List bitbucketServerConfigs resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 50 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— BitbucketServerConfig represents the configuration for a Bitbucket Server.
bitbucketserverconfigs_repos.tsv2026.10.13.1
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 repos
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the repos |
fn sync(identifier?: string)
Sync repos state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific repos by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List repos resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of configs to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— BitbucketServerRepository represents a repository hosted on a Bitbucket Server.
builds.tsv2026.10.13.1
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. |
| artifacts? | object | Required. Path to the generic artifact in the build's workspace to be uploaded to Artifact Registry. |
| availableSecrets? | object | Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. |
| dependencies? | array | If set to true disable all dependency fetching (ignoring the default source as well). |
| gitConfig? | object | SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. |
| images? | array | A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. |
| logsBucket? | string | Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. |
| options? | object | Option to include built-in and custom substitutions as env variables for all build steps. |
| projectId? | string | Output only. ID of the project. |
| queueTtl? | string | TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. |
| secrets? | array | Cloud KMS key name to use to decrypt these envs. |
| serviceAccount? | string | IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. |
| source? | object | Optional. Directory, relative to the source root, in which to run the build. |
| steps? | array | Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence. |
| substitutions? | record | Substitutions data for `Build` resource. |
| tags? | array | Tags for annotation of a `Build`. These are not docker tags. |
| timeout? | string | Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes. |
| parent? | string | The parent resource where this build will be created. Format: `projects/{project}/locations/{location}` |
fn create()
Create a builds
fn get(identifier: string)
Get a builds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the builds |
fn sync(identifier?: string)
Sync builds state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific builds by id (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, parent?: string, maxPages?: number)
List builds resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | The raw filter text to constrain the results. |
| pageSize? | number | Number of results to return in the list. |
| parent? | string | The parent of the collection of `Builds`. Format: `projects/{project}/locations/{location}` |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn approve(approvalResult?: any)
approve
| Argument | Type | Description |
|---|---|---|
| approvalResult? | any |
fn cancel(id?: any, name?: any, projectId?: any)
cancel
| Argument | Type | Description |
|---|---|---|
| id? | any | |
| name? | any | |
| projectId? | any |
fn retry(id?: any, name?: any, projectId?: any)
retry
| Argument | Type | Description |
|---|---|---|
| id? | any | |
| name? | any | |
| projectId? | any |
Resources
state(infinite)— A build resource in the Cloud Build API. At a high level, a `Build` describes...
connections.tsv2026.10.13.1
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. Allows clients to store small amounts of arbitrary data. |
| bitbucketCloudConfig? | object | Required. A SecretManager resource containing the user token that authorizes the Cloud Build connection. Format: `projects/*/secrets/*/versions/*`. |
| bitbucketDataCenterConfig? | object | Required. A SecretManager resource containing the user token that authorizes the Cloud Build connection. Format: `projects/*/secrets/*/versions/*`. |
| disabled? | boolean | Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled. |
| githubConfig? | object | Optional. GitHub App installation id. |
| githubEnterpriseConfig? | object | Required. API Key used for authentication of webhook events. |
| gitlabConfig? | object | Required. A SecretManager resource containing the user token that authorizes the Cloud Build connection. Format: `projects/*/secrets/*/versions/*`. |
| name? | string | Immutable. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`. |
| connectionId? | string | Required. The ID to use for the Connection, which will become the final component of the Connection's resource name. Names must be unique per-project per-location. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@. |
| allowMissing? | string | If set to true, and the connection is not found a new connection will be created. In this situation `update_mask` is ignored. The creation will succeed only if the input connection has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties). |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a connections
fn get(identifier: string)
Get a connections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connections |
fn update(identifier?: string)
Update connections attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific connections by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the connections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connections |
fn sync(identifier?: string)
Sync connections state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific connections by name (e.g. one discovered by list) |
fn list(pageSize?: number, returnPartialSuccess?: boolean, maxPages?: number)
List connections resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Number of results to return in the list. |
| returnPartialSuccess? | boolean | Optional. If set to true, the response will return partial results when some regions are unreachable. If set to false, the response will fail if any region is unreachable. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn fetch_linkable_repositories(pageSize?: any, pageToken?: any)
fetch linkable repositories
| Argument | Type | Description |
|---|---|---|
| pageSize? | any | |
| pageToken? | any |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn process_webhook(contentType?: any, data?: any, extensions?: any, webhookKey?: any)
process webhook
| Argument | Type | Description |
|---|---|---|
| contentType? | any | |
| data? | any | |
| extensions? | any | |
| webhookKey? | 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 connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, ...
connections_repositories.tsv2026.10.13.1
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. Allows clients to store small amounts of arbitrary data. |
| name? | string | Immutable. Resource name of the repository, in the format `projects/*/locations/*/connections/*/repositories/*`. |
| remoteUri? | string | Required. Git Clone HTTPS URI. |
| repositoryId? | string | Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@. |
| 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 repositories
fn get(identifier: string)
Get a repositories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the repositories |
fn delete(identifier: string)
Delete the repositories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the repositories |
fn sync(identifier?: string)
Sync repositories state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific repositories by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, returnPartialSuccess?: boolean, maxPages?: number)
List repositories resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A filter expression that filters resources listed in the response. Expressions must follow API improvement proposal [AIP-160](https://google.aip.dev/160). e.g. `remote_uri:"https://github.com*"`. |
| pageSize? | number | Number of results to return in the list. |
| returnPartialSuccess? | boolean | Optional. If set to true, the response will return partial results when some regions are unreachable. If set to false, the response will fail if any region is unreachable. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn access_read_token()
access read token
fn access_read_write_token()
access read write token
fn batch_create(requests?: any)
batch create
| Argument | Type | Description |
|---|---|---|
| requests? | any |
fn fetch_git_refs(pageSize?: any, pageToken?: any, refType?: any)
fetch git refs
| Argument | Type | Description |
|---|---|---|
| pageSize? | any | |
| pageToken? | any | |
| refType? | any |
Resources
state(infinite)— A repository associated to a parent connection.
githubenterpriseconfigs.tsv2026.10.13.1
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. |
| appId? | string | Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server. |
| displayName? | string | Optional. Name to display for this config. |
| hostUrl? | string | The URL of the github enterprise host the configuration is for. |
| name? | string | Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" |
| peeredNetwork? | string | Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. |
| secrets? | object | The resource name for the OAuth client ID secret in Secret Manager. |
| sslCa? | string | Optional. SSL certificate to use for requests to GitHub Enterprise. |
| webhookKey? | string | The key that should be attached to webhook calls to the ReceiveWebhook endpoint. |
| gheConfigId? | string | Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a githubEnterpriseConfigs
fn get(identifier: string)
Get a githubEnterpriseConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the githubEnterpriseConfigs |
fn update(identifier?: string)
Update githubEnterpriseConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific githubEnterpriseConfigs by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the githubEnterpriseConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the githubEnterpriseConfigs |
fn sync(identifier?: string)
Sync githubEnterpriseConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific githubEnterpriseConfigs by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List githubEnterpriseConfigs resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise ser...
locations.tsv2026.10.13.1
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) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
triggers.tsv2026.10.13.1
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. |
| approvalConfig? | object | Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start. |
| autodetect? | boolean | Autodetect build configuration. The following precedence is used (case insensitive): 1. cloudbuild.yaml 2. cloudbuild.yml 3. cloudbuild.json 4. Dockerfile Currently only available for GitHub App Triggers. |
| bitbucketServerTriggerConfig? | object | Required. Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. |
| build? | object | Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start. |
| description? | string | Human-readable description of this trigger. |
| developerConnectEventConfig? | object | Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`. |
| disabled? | boolean | If true, the trigger will never automatically execute a build. |
| eventType? | enum | EventType allows the user to explicitly set the type of event to which this BuildTrigger should respond. This field will be validated against the rest of the configuration if it is set. |
| filename? | string | Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). |
| filter? | string | A Common Expression Language string. |
| gitFileSource? | object | The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. |
| github? | object | The resource name of the github enterprise config that should be applied to this installation. For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" |
| ignoredFiles? | array | ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. |
| includeBuildLogs? | enum | If set to INCLUDE_BUILD_LOGS_WITH_STATUS, log url will be shown on GitHub page when build status is final. Setting this field to INCLUDE_BUILD_LOGS_WITH_STATUS for non GitHub triggers results in INVALID_ARGUMENT error. |
| includedFiles? | array | If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. |
| name? | string | User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. |
| pubsubConfig? | object | Service account that will make the push request. |
| repositoryEventConfig? | object | Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| resourceName? | string | The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. |
| serviceAccount? | string | The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` |
| sourceToBuild? | object | The full resource name of the bitbucket server config. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`. |
| substitutions? | record | Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. |
| tags? | array | Tags for annotation of a `BuildTrigger` |
| triggerTemplate? | object | Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax |
| webhookConfig? | object | Required. Resource name for the secret required as a URL parameter. |
| projectId? | string | Required. ID of the project for which to configure automatic builds. |
| triggerId? | string | Required. ID of the `BuildTrigger` to update. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a triggers
fn get(identifier: string)
Get a triggers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the triggers |
fn update(identifier?: string)
Update triggers attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific triggers by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the triggers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the triggers |
fn sync(identifier?: string)
Sync triggers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific triggers by name (e.g. one discovered by list) |
fn list(pageSize?: number, projectId?: string, maxPages?: number)
List triggers resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Number of results to return in the list. |
| projectId? | string | Required. ID of the project for which to list BuildTriggers. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn run(projectId?: any, source?: any, triggerId?: any)
run
| Argument | Type | Description |
|---|---|---|
| projectId? | any | |
| source? | any | |
| triggerId? | any |
fn webhook(contentType?: any, data?: any, extensions?: any, projectId?: any, secret?: any, trigger?: any)
webhook
| Argument | Type | Description |
|---|---|---|
| contentType? | any | |
| data? | any | |
| extensions? | any | |
| projectId? | any | |
| secret? | any | |
| trigger? | any |
Resources
state(infinite)— Configuration for an automated build in response to source repository changes.
workerpools.tsv2026.10.13.1
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 | User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations. |
| displayName? | string | A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters. |
| privatePoolV1Config? | object | Option to configure network egress for the workers. |
| workerPoolId? | string | Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a workerPools
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a workerPools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workerPools |
fn update(identifier?: string, waitForReady?: boolean)
Update workerPools attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workerPools by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the workerPools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workerPools |
fn sync(identifier?: string)
Sync workerPools state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workerPools by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List workerPools resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of `WorkerPool`s to return. The service may return fewer than this value. If omitted, the server will use a sensible default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Configuration for a `WorkerPool`. Cloud Build owns and maintains a pool of wo...
04Previous Versions
2026.10.06.1
- Updated: triggers
2026.09.26.1
- Updated: builds, triggers, workerpools
Modified 1 behaviors
2026.09.07.2
- Updated: connections
2026.08.25.1
- Updated: builds
2026.08.23.1
- Updated: builds, triggers
2026.08.18.1
- Updated: githubenterpriseconfigs, triggers
2026.08.12.2
- Updated: locations, connections, connections_repositories, builds, githubenterpriseconfigs, bitbucketserverconfigs, bitbucketserverconfigs_repos, gitlabconfigs, gitlabconfigs_repos, triggers, workerpools
2026.07.29.1
- Updated: locations, connections, connections_repositories, builds, githubenterpriseconfigs, bitbucketserverconfigs, bitbucketserverconfigs_repos, gitlabconfigs, gitlabconfigs_repos, triggers, workerpools
2026.07.21.5
- Added: builds, githubenterpriseconfigs, bitbucketserverconfigs, bitbucketserverconfigs_repos, gitlabconfigs, gitlabconfigs_repos, triggers, workerpools
2026.07.21.1
- Updated: connections, builds, githubenterpriseconfigs, bitbucketserverconfigs, triggers, workerpools
2026.07.20.2
- Added: builds, githubenterpriseconfigs, bitbucketserverconfigs, bitbucketserverconfigs_repos, gitlabconfigs, gitlabconfigs_repos, triggers, workerpools
- Updated: locations
Added 1, removed 3 behaviors
2026.07.20.1
- Updated: locations, connections, connections_repositories
Added 3, removed 1 behaviors
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, connections, connections_repositories, builds, githubenterpriseconfigs, bitbucketserverconfigs, bitbucketserverconfigs_repos, gitlabconfigs, gitlabconfigs_repos, triggers, workerpools
2026.07.18.2
- Updated: locations, connections, connections_repositories, builds, githubenterpriseconfigs, bitbucketserverconfigs, bitbucketserverconfigs_repos, gitlabconfigs, gitlabconfigs_repos, triggers, workerpools
Added 1, removed 11 behaviors
2026.07.17.2
- Updated: connections, connections_repositories, githubenterpriseconfigs, bitbucketserverconfigs, gitlabconfigs, triggers, workerpools
2026.07.17.1
- Updated: connections, connections_repositories, builds, githubenterpriseconfigs, bitbucketserverconfigs, bitbucketserverconfigs_repos, gitlabconfigs, gitlabconfigs_repos, triggers, workerpools
2026.07.11.1
- Updated: githubenterpriseconfigs, bitbucketserverconfigs, gitlabconfigs, gitlabconfigs_repos, triggers
Added 11, removed 1 behaviors
2026.07.08.1
- Updated: builds, triggers
05Stats
A
93 / 100
Downloads
29
Archive size
186.1 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