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.



685
686
687
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 685

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

Instance Attribute Details

#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:



606
607
608
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 606

def build
  @build
end

#create_time ⇒ String

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

Returns:

  • (String) 


611
612
613
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 611

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


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

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) 


621
622
623
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 621

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) 


628
629
630
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 628

def filename
  @filename
end

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

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

Returns:



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

def github
  @github
end

#id ⇒ String

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

Returns:

  • (String) 


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

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>) 


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

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>) 


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

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) 


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

def name
  @name
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>) 


673
674
675
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 673

def substitutions
  @substitutions
end

#tags ⇒ Array<String>

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

Returns:

  • (Array<String>) 


678
679
680
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 678

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:



683
684
685
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 683

def trigger_template
  @trigger_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 690

def update!(**args)
  @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)
  @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)
  @substitutions = args[:substitutions] if args.key?(:substitutions)
  @tags = args[:tags] if args.key?(:tags)
  @trigger_template = args[:trigger_template] if args.key?(:trigger_template)
end