Cloudbuild Build Trigger

This table represents the cloudbuild_build_trigger resource from Google Cloud Platform.

gcp.cloudbuild_build_trigger

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
approval_configcorejsonConfiguration for manual approval to start a build invocation of this BuildTrigger.
autodetectcoreboolAutodetect 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.
bitbucket_server_trigger_configcorejsonBitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received.
buildcorejsonContents of the build template.
create_timecoretimestampOutput only. Time when the trigger was created.
datadog_display_namecorestring
descriptioncorestringHuman-readable description of this trigger.
disabledcoreboolIf true, the trigger will never automatically execute a build.
event_typecorestringEventType 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. Possible values: ['EVENT_TYPE_UNSPECIFIED', 'REPO', 'WEBHOOK', 'PUBSUB', 'MANUAL']. Values descriptions: ['EVENT_TYPE_UNSPECIFIED event_types are ignored.', 'REPO corresponds to the supported VCS integrations.', 'WEBHOOK corresponds to webhook triggers.', 'PUBSUB corresponds to pubsub triggers.', 'MANUAL corresponds to manual-only invoked triggers.']
filenamecorestringPath, from the source root, to the build configuration file (i.e. cloudbuild.yaml).
filtercorestringA Common Expression Language string.
git_file_sourcecorejsonThe file source describing the local or remote Build template.
githubcorejsonGitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`.
gitlab_enterprise_events_configcorejsonGitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received.
idcorestringOutput only. Unique identifier of the trigger.
ignored_filescorearray<string>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.
include_build_logscorestringIf 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. Possible values: ['INCLUDE_BUILD_LOGS_UNSPECIFIED', 'INCLUDE_BUILD_LOGS_WITH_STATUS']. Values descriptions: ['Build logs will not be shown on GitHub.', 'Build logs will be shown on GitHub.']
included_filescorearray<string>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.
labelscorearray<string>
namecorestringUser-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.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
pubsub_configcorejsonPubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
repository_event_configcorejsonThe configuration of a trigger that creates a build whenever an event from Repo API is received.
resource_namecorestring
service_accountcorestringThe 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}`
source_to_buildcorejsonThe 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.
tagscorehstore
trigger_templatecorejsonTemplate 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. Mutually exclusive with `github`.
webhook_configcorejsonWebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.