TriggerArgs class

The set of arguments for Trigger. The set of arguments for Trigger.

Constructors

TriggerArgs({Input<TriggerApprovalConfig?>? approvalConfig, Input<TriggerBitbucketServerTriggerConfig?>? bitbucketServerTriggerConfig, Input<TriggerBuild?>? build, Input<String?>? deletionPolicy, Input<String?>? description, Input<TriggerDeveloperConnectEventConfig?>? developerConnectEventConfig, Input<bool?>? disabled, Input<String?>? filename, Input<String?>? filter, Input<TriggerGitFileSource?>? gitFileSource, Input<TriggerGithub?>? github, Input<List<String>?>? ignoredFiles, Input<String?>? includeBuildLogs, Input<List<String>?>? includedFiles, Input<String?>? location, Input<String?>? name, Input<String?>? project, Input<TriggerPubsubConfig?>? pubsubConfig, Input<TriggerRepositoryEventConfig?>? repositoryEventConfig, Input<String?>? serviceAccount, Input<TriggerSourceToBuild?>? sourceToBuild, Input<Map<String, String>?>? substitutions, Input<List<String>?>? tags, Input<TriggerTriggerTemplate?>? triggerTemplate, Input<TriggerWebhookConfig?>? webhookConfig})
Creates a new TriggerArgs. approvalConfig Configuration for manual approval to start a build invocation of this BuildTrigger. bitbucketServerTriggerConfig BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. build Contents of the build template. Either a filename or build template must be provided. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description Human-readable description of the trigger. developerConnectEventConfig Configuration for triggers that respond to Developer Connect events. disabled Whether the trigger is disabled or not. If true, the trigger will never result in a build. filename Path, from the source root, to a file whose contents is used for the template. filter A Common Expression Language string. Used only with Pub/Sub and Webhook. gitFileSource The file source describing the local or remote Build template. github Describes the configuration of a trigger that creates a build whenever a GitHub event is received. ignoredFiles ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match includeBuildLogs Build logs will be sent back to GitHub as part of the checkrun includedFiles ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match location The Cloud Build location for the trigger. name Name of the trigger. Must be unique within the project. project The ID of the project in which the resource belongs. pubsubConfig PubsubConfig describes the configuration of a trigger that creates repositoryEventConfig The configuration of a trigger that creates a build whenever an event from Repo API is received. serviceAccount The service account used for all user-controlled operations including sourceToBuild The repo and ref of the repository from which to build. substitutions Substitutions data for Build resource. tags Tags for annotation of a BuildTrigger triggerTemplate Template describing the types of source changes to trigger a build. webhookConfig WebhookConfig describes the configuration of a trigger that creates
const
TriggerArgs.fromMap(Map<String, dynamic> map)
factory

Properties

approvalConfig → Input<TriggerApprovalConfig?>?
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. Structure is documented below.
final
bitbucketServerTriggerConfig → Input<TriggerBitbucketServerTriggerConfig?>?
BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. Structure is documented below.
final
build → Input<TriggerBuild?>?
Contents of the build template. Either a filename or build template must be provided. Structure is documented below.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
Human-readable description of the trigger.
final
developerConnectEventConfig → Input<TriggerDeveloperConnectEventConfig?>?
Configuration for triggers that respond to Developer Connect events. Structure is documented below.
final
disabled → Input<bool?>?
Whether the trigger is disabled or not. If true, the trigger will never result in a build.
final
filename → Input<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 triggerTemplate or github. When using Pub/Sub, Webhook or Manual set the file name using gitFileSource instead.
final
filter → Input<String?>?
A Common Expression Language string. Used only with Pub/Sub and Webhook.
final
gitFileSource → Input<TriggerGitFileSource?>?
The file source describing the local or remote Build template. Structure is documented below.
final
github → Input<TriggerGithub?>?
Describes the configuration of a trigger that creates a build whenever a GitHub event is received. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
ignoredFiles → Input<List<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 ignoredFile globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.
final
includeBuildLogs → Input<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 Possible values are: INCLUDE_BUILD_LOGS_UNSPECIFIED, INCLUDE_BUILD_LOGS_WITH_STATUS.
final
includedFiles → Input<List<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.
final
location → Input<String?>?
The Cloud Build location for the trigger. If not specified, "global" is used.
final
name → Input<String?>?
Name of the trigger. Must be unique within the project.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pubsubConfig → Input<TriggerPubsubConfig?>?
PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. Structure is documented below.
final
repositoryEventConfig → Input<TriggerRepositoryEventConfig?>?
The configuration of a trigger that creates a build whenever an event from Repo API is received. Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceAccount → Input<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}
final
sourceToBuild → Input<TriggerSourceToBuild?>?
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. Structure is documented below.
final
substitutions → Input<Map<String, String>?>?
Substitutions data for Build resource.
final
tags → Input<List<String>?>?
Tags for annotation of a BuildTrigger
final
triggerTemplate → Input<TriggerTriggerTemplate?>?
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. Structure is documented below.
final
webhookConfig → Input<TriggerWebhookConfig?>?
WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited