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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudbuild_v1/classes.rb,
generated/google/apis/cloudbuild_v1/representations.rb,
generated/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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BuildTrigger

Returns a new instance of BuildTrigger



609
610
611
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 609

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.
  • $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:



548
549
550
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 548

def build
  @build
end

#create_time ⇒ String

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

Returns:

  • (String) 


553
554
555
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 553

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


558
559
560
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 558

def description
  @description
end

#disabled ⇒ Boolean Also known as: disabled?

If true, the trigger will never result in a build. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


563
564
565
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 563

def disabled
  @disabled
end

#filename ⇒ String

Path, from the source root, to a file whose contents is used for the template. Corresponds to the JSON property filename

Returns:

  • (String) 


570
571
572
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 570

def filename
  @filename
end

#id ⇒ String

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

Returns:

  • (String) 


575
576
577
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 575

def id
  @id
end

#ignored_files ⇒ Array<String>

ignored_files and included_files are file glob matches using http://godoc/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>) 


586
587
588
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 586

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


597
598
599
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 597

def included_files
  @included_files
end

#substitutions ⇒ Hash<String,String>

Substitutions data for Build resource. Corresponds to the JSON property substitutions

Returns:

  • (Hash<String,String>) 


602
603
604
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 602

def substitutions
  @substitutions
end

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

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

Returns:



607
608
609
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 607

def trigger_template
  @trigger_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 614

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