Class BuildTrigger (3.14.0)

BuildTrigger(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration for an automated build in response to source repository changes.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
resource_name str
The Trigger name with format: projects/{project}/locations/{location}/triggers/{trigger}, where {trigger} is a unique identifier generated by the service.
id str
Output only. Unique identifier of the trigger.
description str
Human-readable description of this trigger.
name str
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.
tags MutableSequence[str]
Tags for annotation of a BuildTrigger
trigger_template google.cloud.devtools.cloudbuild_v1.types.RepoSource
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. Mutually exclusive with github.
github google.cloud.devtools.cloudbuild_v1.types.GitHubEventsConfig
GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with trigger_template.
pubsub_config google.cloud.devtools.cloudbuild_v1.types.PubsubConfig
PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
webhook_config google.cloud.devtools.cloudbuild_v1.types.WebhookConfig
WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.
autodetect bool
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. This field is a member of oneof_ build_template.
build google.cloud.devtools.cloudbuild_v1.types.Build
Contents of the build template. This field is a member of oneof_ build_template.
filename str
Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). This field is a member of oneof_ build_template.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Time when the trigger was created.
disabled bool
If true, the trigger will never automatically execute a build.
substitutions MutableMapping[str, str]
Substitutions for Build resource. The keys must match the following regular expression: ^_[A-Z0-9_]+$.
ignored_files MutableSequence[str]
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.
included_files MutableSequence[str]
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.
filter str
Optional. A Common Expression Language string.
service_account str
The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. 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}

Classes

SubstitutionsEntry

SubstitutionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.