Cloud Build v1 API - Class BuildTrigger (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class BuildTrigger : IMessage<BuildTrigger>, IEquatable<BuildTrigger>, IDeepCloneable<BuildTrigger>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Build v1 API class BuildTrigger.

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

Inheritance

Object > BuildTrigger

Namespace

Google.Cloud.CloudBuild.V1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

BuildTrigger()

public BuildTrigger()

BuildTrigger(BuildTrigger)

public BuildTrigger(BuildTrigger other)
Parameter
NameDescription
otherBuildTrigger

Properties

Autodetect

public bool Autodetect { get; set; }

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.

Property Value
TypeDescription
Boolean

Build

public Build Build { get; set; }

Contents of the build template.

Property Value
TypeDescription
Build

BuildTemplateCase

public BuildTrigger.BuildTemplateOneofCase BuildTemplateCase { get; }
Property Value
TypeDescription
BuildTrigger.BuildTemplateOneofCase

BuildTriggerName

public BuildTriggerName BuildTriggerName { get; set; }

BuildTriggerName-typed view over the Name resource name property.

Property Value
TypeDescription
BuildTriggerName

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Time when the trigger was created.

Property Value
TypeDescription
Timestamp

Description

public string Description { get; set; }

Human-readable description of this trigger.

Property Value
TypeDescription
String

Disabled

public bool Disabled { get; set; }

If true, the trigger will never automatically execute a build.

Property Value
TypeDescription
Boolean

Filename

public string Filename { get; set; }

Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml).

Property Value
TypeDescription
String

Filter

public string Filter { get; set; }

Optional. A Common Expression Language string.

Property Value
TypeDescription
String

Github

public GitHubEventsConfig Github { get; set; }

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

Mutually exclusive with trigger_template.

Property Value
TypeDescription
GitHubEventsConfig

Id

public string Id { get; set; }

Output only. Unique identifier of the trigger.

Property Value
TypeDescription
String

IgnoredFiles

public RepeatedField<string> IgnoredFiles { get; }

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.

Property Value
TypeDescription
RepeatedField<String>

IncludedFiles

public RepeatedField<string> IncludedFiles { get; }

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.

Property Value
TypeDescription
RepeatedField<String>

Name

public string Name { get; set; }

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.
Property Value
TypeDescription
String

PubsubConfig

public PubsubConfig PubsubConfig { get; set; }

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

Property Value
TypeDescription
PubsubConfig

ResourceName

public string ResourceName { get; set; }

The Trigger name with format: projects/{project}/locations/{location}/triggers/{trigger}, where {trigger} is a unique identifier generated by the service.

Property Value
TypeDescription
String

ServiceAccount

public string ServiceAccount { get; set; }

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}

Property Value
TypeDescription
String

ServiceAccountAsServiceAccountName

public ServiceAccountName ServiceAccountAsServiceAccountName { get; set; }

ServiceAccountName-typed view over the ServiceAccount resource name property.

Property Value
TypeDescription
ServiceAccountName

Substitutions

public MapField<string, string> Substitutions { get; }

Substitutions for Build resource. The keys must match the following regular expression: ^_[A-Z0-9_]+$.

Property Value
TypeDescription
MapField<String, String>

Tags

public RepeatedField<string> Tags { get; }

Tags for annotation of a BuildTrigger

Property Value
TypeDescription
RepeatedField<String>

TriggerTemplate

public RepoSource TriggerTemplate { get; set; }

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.

Property Value
TypeDescription
RepoSource

WebhookConfig

public WebhookConfig WebhookConfig { get; set; }

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

Property Value
TypeDescription
WebhookConfig