google.cloud.gcp_cloudbuild_trigger module – Creates a GCP CloudBuild.Trigger resource

access_token

string

The access token used to authenticate.

approval_config

dictionary

Configuration for manual approval to start a build invocation of this BuildTrigger.

Builds created by this trigger will require approval before they execute.

Any user with a Cloud Build Approver role for the project can approve a build.

approval_required

boolean

Whether or not approval is needed.

If this is set on a build, it will become pending when run, and will need to be explicitly approved to start.

Choices:

• false ← (default)
• true

auth_kind

string / required

The type of credential used.

Choices:

• "accesstoken"
• "application"
• "machineaccount"
• "serviceaccount"

bitbucket_server_trigger_config

dictionary

BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received.

bitbucket_server_config_resource

string / required

The Bitbucket server config resource that this trigger config maps to.

project_key

string / required

Key of the project that the repo is in.

For example: The key for https://mybitbucket.server/projects/TEST/repos/test-repo is “TEST”.

pull_request

dictionary

Filter to match changes in pull requests.

branch

string / required

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.

comment_control

string

Configure builds to run whether a repository owner or collaborator need to comment /gcbrun.

Choices:

• "COMMENTS_DISABLED"
• "COMMENTS_ENABLED"
• "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY"

invert_regex

boolean

If true, branches that do NOT match the git_ref will trigger a build.

Choices:

• false
• true

push

dictionary

Filter to match changes in refs like branches, tags.

branch

string

Regex of branches to match.

Specify only one of branch or tag.

invert_regex

boolean

When true, only trigger a build if the revision regex does NOT match the gitRef regex.

Choices:

• false
• true

tag

string

Regex of tags to match.

Specify only one of branch or tag.

repo_slug

string / required

Slug of the repository.

A repository slug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL.

For example, if the repository name is ‘test repo’, in the URL it would become ‘test-repo’ as in https://mybitbucket.server/projects/TEST/repos/test-repo.

build

dictionary

Contents of the build template.

Either a filename or build template must be provided.

artifacts

dictionary

Artifacts produced by the build that should be uploaded upon successful completion of all build steps.

images

list / elements=string

A list of images to be pushed upon the successful completion of all build steps.

The images will be 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 is marked FAILURE.

maven_artifacts

list / elements=dictionary

A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.

The location and generation of the uploaded objects will be stored in the Build resource’s results field.

If any objects fail to be pushed, the build is marked FAILURE.

artifact_id

string

Maven artifactId value used when uploading the artifact to Artifact Registry.

group_id

string

Maven groupId value used when uploading the artifact to Artifact Registry.

path

string

Path to an artifact in the build’s workspace to be uploaded to Artifact Registry.

This can be either an absolute path, e.g.

/workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g.

my-app/target/my-app-1.0.SNAPSHOT.jar.

repository

string

Artifact Registry repository, in the form “https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY” Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix.

version

string

Maven version value used when uploading the artifact to Artifact Registry.

npm_packages

list / elements=dictionary

Npm package to upload to Artifact Registry upon successful completion of all build steps.

The location and generation of the uploaded objects will be stored in the Build resource’s results field.

If any objects fail to be pushed, the build is marked FAILURE.

package_path

string

Path to the package.json.

e.g.

workspace/path/to/package.

repository

string

Artifact Registry repository, in the form “https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY” Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix.

objects

dictionary

A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps.

Files in the workspace matching specified paths globs will be uploaded to the Cloud Storage location using the builder service account’s credentials.

The location and generation of the uploaded objects will be stored in the Build resource’s results field.

If any objects fail to be pushed, the build is marked FAILURE.

location

string

Cloud Storage bucket and optional object path, in the form “gs://bucket/path/to/somewhere/”.

Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.

paths

list / elements=string

Path globs used to match files in the build’s workspace.

timing

dictionary

Output only.

Stores timing information for pushing all artifact objects.

end_time

string

End of time span.

A timestamp in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits.

Examples: “2014-10-02T15:01:23Z” and “2014-10-02T15:01:23.045123456Z”.

start_time

string

Start of time span.

A timestamp in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits.

Examples: “2014-10-02T15:01:23Z” and “2014-10-02T15:01:23.045123456Z”.

python_packages

list / elements=dictionary

Python package to upload to Artifact Registry upon successful completion of all build steps.

A package can encapsulate multiple objects to be uploaded to a single repository.

The location and generation of the uploaded objects will be stored in the Build resource’s results field.

If any objects fail to be pushed, the build is marked FAILURE.

paths

list / elements=string

Path globs used to match files in the build’s workspace.

For Python/ Twine, this is usually dist/*, and sometimes additionally an .asc file.

repository

string

Artifact Registry repository, in the form “https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY” Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix.

available_secrets

dictionary

Secrets and secret environment variables.

secret_manager

list / elements=dictionary / required

Pairs a secret environment variable with a SecretVersion in Secret Manager.

env

string / required

Environment variable name to associate with the secret.

Secret environment variables must be unique across all of a build’s secrets, and must be used by at least one build step.

version_name

string / required

Resource name of the SecretVersion.

In format: projects/*/secrets/*/versions/*.

images

list / elements=string

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.

logs_bucket

string

Google Cloud Storage bucket where logs should be written.

Logs file names will be of the format ${logsBucket}/log-${build_id}.txt.

options

dictionary

Special options for this build.

disk_size_gb

integer

Requested disk size for the VM that runs the build.

Note that this is NOT “disk free”; some of the space will be used by the operating system and build utilities.

Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested.

At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error.

dynamic_substitutions

boolean

Option to specify whether or not to apply bash style string operations to the substitutions.

NOTE this is always enabled for triggered builds and cannot be overridden in the build configuration file.

Choices:

• false
• true

env

list / elements=string

A list of global environment variable definitions that will exist for all build steps in this build.

If a variable is defined in both globally and in a build step, the variable will use the build step value.

The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.

log_streaming_option

string

Option to define build log streaming behavior to Google Cloud Storage.

Choices:

• "STREAM_DEFAULT"
• "STREAM_ON"
• "STREAM_OFF"

logging

string

Option to specify the logging mode, which determines if and where build logs are stored.

Choices:

• "LOGGING_UNSPECIFIED"
• "LEGACY"
• "GCS_ONLY"
• "STACKDRIVER_ONLY"
• "CLOUD_LOGGING_ONLY"
• "NONE"

machine_type

string

Compute Engine machine type on which to run the build.

requested_verify_option

string

Requested verifiability options.

Choices:

• "NOT_VERIFIED"
• "VERIFIED"

secret_env

list / elements=string

A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.

These values must be specified in the build’s Secret.

These variables will be available to all build steps in this build.

source_provenance_hash

list / elements=string

Requested hash for SourceProvenance.

substitution_option

string

Option to specify behavior when there is an error in the substitution checks.

NOTE this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.

Choices:

• "MUST_MATCH"
• "ALLOW_LOOSE"

volumes

list / elements=dictionary

Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process.

Upon completion of the build, volumes and their contents are discarded.

Global volume names and paths cannot conflict with the volumes defined a build step.

Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.

name

string

Name of the volume to mount.

Volume names must be unique per build step and must be valid names for Docker volumes.

Each named volume must be used by at least two build steps.

path

string

Path at which to mount the volume.

Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

worker_pool

string

Option to specify a WorkerPool for the build.

Format projects/{project}/workerPools/{workerPool} This field is experimental.

queue_ttl

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

A duration in seconds with up to nine fractional digits, terminated by ‘s’.

Example: “3.5s”.

secret

list / elements=dictionary

Secrets to decrypt using Cloud Key Management Service.

kms_key_name

string / required

Cloud KMS key name to use to decrypt these envs.

secret_env

dictionary

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.

source

dictionary

The location of the source files to build.

One of `storageSource` or `repoSource` must be provided.

repo_source

dictionary

Location of the source in a Google Cloud Source Repository.

branch_name

string

Regex matching branches to build.

Exactly one a of branch name, tag, or commit SHA must be provided.

The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax.

commit_sha

string

Explicit commit SHA to build.

Exactly one a of branch name, tag, or commit SHA must be provided.

dir

string

Directory, relative to the source root, in which to run the build.

This must be a relative path.

If a step’s dir is specified and is an absolute path, this value is ignored for that step’s execution.

invert_regex

boolean

Only trigger a build if the revision regex does NOT match the revision regex.

Choices:

• false
• true

project_id

string

ID of the project that owns the Cloud Source Repository.

If omitted, the project ID requesting the build is assumed.

repo_name

string / required

Name of the Cloud Source Repository.

substitutions

dictionary

Substitutions to use in a triggered build.

Should only be used with triggers.run.

tag_name

string

Regex matching tags to build.

Exactly one a of branch name, tag, or commit SHA must be provided.

The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax.

storage_source

dictionary

Location of the source in an archive file in Google Cloud Storage.

bucket

string / required

Google Cloud Storage bucket containing the source.

generation

string

Google Cloud Storage generation for the object.

If the generation is omitted, the latest generation will be used.

object

string / required

Google Cloud Storage object containing the source.

This object must be a gzipped archive file (.tar.gz) containing source to build.

step

list / elements=dictionary / required

The operations to be performed on the workspace.

allow_exit_codes

list / elements=integer

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 `allowFailure` is also specified, this field will take precedence.

allow_failure

boolean

Allow this build step to fail without failing the entire build.

If false, the entire build will fail if this step fails.

Otherwise, the build will succeed, but this step will still have a failure status.

Error information will be reported in the `failureDetail` field.

`allowExitCodes` takes precedence over this field.

Choices:

• false
• true

args

list / elements=string

A list of arguments that will be presented to the step when it is started.

If the image used to run the step’s container has an entrypoint, the args are used as arguments to that entrypoint.

If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.

dir

string

Working directory to use when running this step’s container.

If this value is a relative path, it is relative to the build’s working directory.

If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified.

If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step’s execution.

entrypoint

string

Entrypoint to be used instead of the build step image’s default entrypoint.

If unset, the image’s default entrypoint is used.

env

list / elements=string

A list of environment variable definitions to be used when running a step.

The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.

id

string

Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.

name

string / required

The name of the container image that will run this particular build step.

If the image is available in the host’s Docker daemon’s cache, it will be run directly.

If not, the host will attempt to pull the image first, using the builder service account’s credentials if necessary.

The Docker daemon’s cache will already have the latest versions of all of the officially supported build steps (see https://github.com/GoogleCloudPlatform/cloud-builders for images and examples).

The Docker daemon will also have cached many of the layers for some popular images, like “ubuntu”, “debian”, but they will be refreshed at the time you attempt to use them.

If you built an image in a previous build step, it will be stored in the host’s Docker daemon’s cache and is available to use as the name for a later build step.

script

string

A shell script to be executed in the step.

When script is provided, the user cannot specify the entrypoint or args.

secret_env

list / elements=string

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key.

These values must be specified in the build’s `Secret`.

timeout

string

Time limit for executing this build step.

If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

timing

string

Output only.

Stores timing information for executing this build step.

volumes

list / elements=dictionary

List of volumes to mount into the build step.

Each volume is created as an empty volume prior to execution of the build step.

Upon completion of the build, volumes and their contents are discarded.

Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.

name

string / required

Name of the volume to mount.

Volume names must be unique per build step and must be valid names for Docker volumes.

Each named volume must be used by at least two build steps.

path

string / required

Path at which to mount the volume.

Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

wait_for

list / elements=string

The ID(s) of the step(s) that this build step depends on.

This build step will not start until all the build steps in `wait_for` have completed successfully.

If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.

substitutions

dictionary

Substitutions data for Build resource.

tags

list / elements=string

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.

This timeout must be equal to or greater than the sum of the timeouts for build steps within the build.

The expected format is the number of seconds followed by s.

Default time is ten minutes (600s).

Default: "600s"

description

string

Human-readable description of the trigger.

disabled

boolean

Whether the trigger is disabled or not.

If true, the trigger will never result in a build.

Choices:

• false
• true

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

filename

string

Path, from the source root, to a file whose contents is used for the template.

Either a filename or build template must be provided.

Set this only when using trigger_template or github.

When using Pub/Sub, Webhook or Manual set the file name using git_file_source instead.

filter

string

A Common Expression Language string.

Used only with Pub/Sub and Webhook.

git_file_source

dictionary

The file source describing the local or remote Build template.

bitbucket_server_config

string

The full resource name of the bitbucket server config.

Format: projects/{project}/locations/{location}/bitbucketServerConfigs/{id}.

github_enterprise_config

string

The full resource name of the github enterprise config.

Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}.

projects/{project}/githubEnterpriseConfigs/{id}.

path

string / required

The path of the file, with the repo root as the root of the path.

repo_type

string / required

The type of the repo, since it may not be explicit from the repo field (e.g from a URL).

Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER.

Choices:

• "UNKNOWN"
• "CLOUD_SOURCE_REPOSITORIES"
• "GITHUB"
• "BITBUCKET_SERVER"

repository

string

The fully qualified resource name of the Repo API repository.

The fully qualified resource name of the Repo API repository.

If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path.

revision

string

The branch, tag, arbitrary ref, or SHA version of the repo to use when resolving the filename (optional).

This field respects the same syntax/resolution as described here: https://git-scm.com/docs/gitrevisions If unspecified, the revision from which the trigger invocation originated is assumed to be the revision from which to read the specified path.

uri

string

The URI of the repo (optional).

If unspecified, the repo from which the trigger invocation originated is assumed to be the repo from which to read the specified path.

github

dictionary

Describes the configuration of a trigger that creates a build whenever a GitHub event is received.

One of `trigger_template`, `github`, `pubsub_config` or `webhook_config` must be provided.

enterprise_config_resource_name

string

The resource name of the github enterprise config that should be applied to this installation.

For example: “projects/{$projectId}/locations/{$locationId}/githubEnterpriseConfigs/{$configId}”.

name

string

Name of the repository.

For example: The name for https://github.com/googlecloudplatform/cloud-builders is “cloud-builders”.

owner

string

Owner of the repository.

For example: The owner for https://github.com/googlecloudplatform/cloud-builders is “googlecloudplatform”.

pull_request

dictionary

filter to match changes in pull requests.

Specify only one of `pull_request` or `push`.

branch

string / required

Regex of branches to match.

comment_control

string

Whether to block builds on a “/gcbrun” comment from a repository owner or collaborator.

Choices:

• "COMMENTS_DISABLED"
• "COMMENTS_ENABLED"
• "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY"

invert_regex

boolean

If true, branches that do NOT match the git_ref will trigger a build.

Choices:

• false
• true

push

dictionary

filter to match changes in refs, like branches or tags.

Specify only one of `pull_request` or `push`.

branch

string

Regex of branches to match.

Specify only one of branch or tag.

invert_regex

boolean

When true, only trigger a build if the revision regex does NOT match the git_ref regex.

Choices:

• false
• true

tag

string

Regex of tags to match.

Specify only one of branch or tag.

ignored_files

list / elements=string

ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for `**`.

If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build.

If ignoredFiles 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 ignoredFiles globs, then we do not trigger a build.

include_build_logs

string

Build logs will be sent back to GitHub as part of the checkrun result.

Values can be INCLUDE_BUILD_LOGS_UNSPECIFIED or INCLUDE_BUILD_LOGS_WITH_STATUS.

Choices:

• "INCLUDE_BUILD_LOGS_UNSPECIFIED"
• "INCLUDE_BUILD_LOGS_WITH_STATUS"

included_files

list / elements=string

ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for `**`.

If any of the files altered in the commit pass the ignoredFiles filter and includedFiles 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 ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob.

If not, then we do not trigger a build.

location

string

The [Cloud Build location](https://cloud.google.com/build/docs/locations) for the trigger.

If not specified, “global” is used.

Default: "global"

name

string

Name of the trigger.

Must be unique within the project.

project

string

The Google Cloud Platform project to use.

pubsub_config

dictionary

PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.

One of `trigger_template`, `github`, `pubsub_config` `webhook_config` or `source_to_build` must be provided.

service_account_email

string

Service account that will make the push request.

state

string

Potential issues with the underlying Pub/Sub subscription configuration.

Only populated on get requests.

subscription

string

Output only.

Name of the subscription.

topic

string / required

The name of the topic from which this subscription is receiving messages.

repository_event_config

dictionary

The configuration of a trigger that creates a build whenever an event from Repo API is received.

pull_request

dictionary

Contains filter properties for matching Pull Requests.

branch

string

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.

comment_control

string

Configure builds to run whether a repository owner or collaborator need to comment `/gcbrun`.

Choices:

• "COMMENTS_DISABLED"
• "COMMENTS_ENABLED"
• "COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY"

invert_regex

boolean

If true, branches that do NOT match the git_ref will trigger a build.

Choices:

• false
• true

push

dictionary

Contains filter properties for matching git pushes.

branch

string

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.

invert_regex

boolean

If true, only trigger a build if the revision regex does NOT match the git_ref regex.

Choices:

• false
• true

tag

string

Regex of tags 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.

repository

string

The resource name of the Repo API resource.

scopes

list / elements=string

Array of scopes to be used.

service_account

string

The service account used for all user-controlled operations including triggers.patch, triggers.run, builds.create, and builds.cancel.

If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead.

Format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}.

service_account_contents

jsonarg

The contents of a Service Account JSON file,

either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is

selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount

is selected as type.

source_to_build

dictionary

The repo and ref of the repository from which to build.

This field is used only for those triggers that do not respond to SCM events.

Triggers that respond to such events build source at whatever commit caused the event.

This field is currently only used by Webhook, Pub/Sub, Manual, and Cron triggers.

One of `trigger_template`, `github`, `pubsub_config` `webhook_config` or `source_to_build` must be provided.

bitbucket_server_config

string

The full resource name of the bitbucket server config.

Format: projects/{project}/locations/{location}/bitbucketServerConfigs/{id}.

github_enterprise_config

string

The full resource name of the github enterprise config.

Format: projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}.

projects/{project}/githubEnterpriseConfigs/{id}.

ref

string / required

The branch or tag to use.

Must start with “refs/” (required).

repo_type

string / required

The type of the repo, since it may not be explicit from the repo field (e.g from a URL).

Values can be UNKNOWN, CLOUD_SOURCE_REPOSITORIES, GITHUB, BITBUCKET_SERVER.

Choices:

• "UNKNOWN"
• "CLOUD_SOURCE_REPOSITORIES"
• "GITHUB"
• "BITBUCKET_SERVER"

repository

string

The qualified resource name of the Repo API repository.

Either uri or repository can be specified and is required.

uri

string

The URI of the repo.

state

string

Whether the resource should exist in GCP.

Choices:

• "present" ← (default)
• "absent"

substitutions

dictionary

Substitutions data for Build resource.

tags

list / elements=string

Tags for annotation of a BuildTrigger.

trigger_template

dictionary

Template describing the types of source changes to trigger a build.

Branch and tag names in trigger templates are interpreted as regular expressions.

Any branch or tag change that matches that regular expression will trigger a build.

One of `trigger_template`, `github`, `pubsub_config`, `webhook_config` or `source_to_build` must be provided.

branch_name

string

Name of the branch to build.

Exactly one a of branch name, tag, or commit SHA must be provided.

This field is a regular expression.

commit_sha

string

Explicit commit SHA to build.

Exactly one of a branch name, tag, or commit SHA must be provided.

dir

string

Directory, relative to the source root, in which to run the build.

This must be a relative path.

If a step’s dir is specified and is an absolute path, this value is ignored for that step’s execution.

invert_regex

boolean

Only trigger a build if the revision regex does NOT match the revision regex.

Choices:

• false
• true

project_id

string

ID of the project that owns the Cloud Source Repository.

If omitted, the project ID requesting the build is assumed.

repo_name

string

Name of the Cloud Source Repository.

If omitted, the name “default” is assumed.

Default: "default"

tag_name

string

Name of the tag to build.

Exactly one of a branch name, tag, or commit SHA must be provided.

This field is a regular expression.

webhook_config

dictionary

WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger’s webhook URL.

One of `trigger_template`, `github`, `pubsub_config` `webhook_config` or `source_to_build` must be provided.

secret

string / required

Resource name for the secret required as a URL parameter.

state

string

Potential issues with the underlying Pub/Sub subscription configuration.

Only populated on get requests.

changed

boolean

Whether the resource was changed.

Returned: always

createTime

string

Time when the trigger was created.

Returned: success

state

string

The current state of the resource.

Returned: always

trigger_id

string

The unique identifier for the trigger.

Returned: success