Class: Google::Apis::CloudbuildV1::BuildTrigger

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudbuild_v1/classes.rb,
lib/google/apis/cloudbuild_v1/representations.rb,
lib/google/apis/cloudbuild_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BuildTrigger

Returns a new instance of BuildTrigger.



750
751
752
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 750

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#autodetect ⇒ Boolean Also known as: autodetect?

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. Corresponds to the JSON property autodetect

Returns:

  • (Boolean) 


617
618
619
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 617

def autodetect
  @autodetect
end

#build ⇒ Google::Apis::CloudbuildV1::Build

A build resource in the Cloud Build API. At a high level, a Build describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $ PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. Corresponds to the JSON property build

Returns:



633
634
635
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 633

def build
  @build
end

#create_time ⇒ String

Output only. Time when the trigger was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


638
639
640
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 638

def create_time
  @create_time
end

#description ⇒ String

Human-readable description of this trigger. Corresponds to the JSON property description

Returns:

  • (String) 


643
644
645
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 643

def description
  @description
end

#disabled ⇒ Boolean Also known as: disabled?

If true, the trigger will never automatically execute a build. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


648
649
650
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 648

def disabled
  @disabled
end

#filename ⇒ String

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

Returns:

  • (String) 


655
656
657
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 655

def filename
  @filename
end

#filter ⇒ String

Optional. A Common Expression Language string. Corresponds to the JSON property filter

Returns:

  • (String) 


660
661
662
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 660

def filter
  @filter
end

#github ⇒ Google::Apis::CloudbuildV1::GitHubEventsConfig

GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Corresponds to the JSON property github

Returns:



666
667
668
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 666

def github
  @github
end

#id ⇒ String

Output only. Unique identifier of the trigger. Corresponds to the JSON property id

Returns:

  • (String) 


671
672
673
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 671

def id
  @id
end

#ignored_files ⇒ Array<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. Corresponds to the JSON property ignoredFiles

Returns:

  • (Array<String>) 


681
682
683
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 681

def ignored_files
  @ignored_files
end

#included_files ⇒ Array<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. Corresponds to the JSON property includedFiles

Returns:

  • (Array<String>) 


691
692
693
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 691

def included_files
  @included_files
end

#name ⇒ String

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. Corresponds to the JSON property name

Returns:

  • (String) 


699
700
701
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 699

def name
  @name
end

#pubsub_config ⇒ Google::Apis::CloudbuildV1::PubsubConfig

PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. Corresponds to the JSON property pubsubConfig

Returns:



705
706
707
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 705

def pubsub_config
  @pubsub_config
end

#resource_name ⇒ String

The Trigger name with format: projects/project/locations/location/ triggers/trigger`, wheretriggeris a unique identifier generated by the service. Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


712
713
714
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 712

def resource_name
  @resource_name
end

#service_account ⇒ String

Optional. 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` Corresponds to the JSON propertyserviceAccount`

Returns:

  • (String) 


721
722
723
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 721

def 
  @service_account
end

#source_to_build ⇒ Google::Apis::CloudbuildV1::GitRepoSource

GitRepoSource describes a repo and ref of a code repository. Corresponds to the JSON property sourceToBuild

Returns:



726
727
728
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 726

def source_to_build
  @source_to_build
end

#substitutions ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


732
733
734
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 732

def substitutions
  @substitutions
end

#tags ⇒ Array<String>

Tags for annotation of a BuildTrigger Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


737
738
739
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 737

def tags
  @tags
end

#trigger_template ⇒ Google::Apis::CloudbuildV1::RepoSource

Location of the source in a Google Cloud Source Repository. Corresponds to the JSON property triggerTemplate

Returns:



742
743
744
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 742

def trigger_template
  @trigger_template
end

#webhook_config ⇒ Google::Apis::CloudbuildV1::WebhookConfig

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

Returns:



748
749
750
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 748

def webhook_config
  @webhook_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 755

def update!(**args)
  @autodetect = args[:autodetect] if args.key?(:autodetect)
  @build = args[:build] if args.key?(:build)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @disabled = args[:disabled] if args.key?(:disabled)
  @filename = args[:filename] if args.key?(:filename)
  @filter = args[:filter] if args.key?(:filter)
  @github = args[:github] if args.key?(:github)
  @id = args[:id] if args.key?(:id)
  @ignored_files = args[:ignored_files] if args.key?(:ignored_files)
  @included_files = args[:included_files] if args.key?(:included_files)
  @name = args[:name] if args.key?(:name)
  @pubsub_config = args[:pubsub_config] if args.key?(:pubsub_config)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @service_account = args[:service_account] if args.key?(:service_account)
  @source_to_build = args[:source_to_build] if args.key?(:source_to_build)
  @substitutions = args[:substitutions] if args.key?(:substitutions)
  @tags = args[:tags] if args.key?(:tags)
  @trigger_template = args[:trigger_template] if args.key?(:trigger_template)
  @webhook_config = args[:webhook_config] if args.key?(:webhook_config)
end