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.



1539
1540
1541
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1539

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

Instance Attribute Details

#approval_config ⇒ Google::Apis::CloudbuildV1::ApprovalConfig

ApprovalConfig describes configuration for manual approval of a build. Corresponds to the JSON property approvalConfig

Returns:



1353
1354
1355
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1353

def approval_config
  @approval_config
end

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


1360
1361
1362
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1360

def autodetect
  @autodetect
end

#bitbucket_server_trigger_config ⇒ Google::Apis::CloudbuildV1::BitbucketServerTriggerConfig

BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. Corresponds to the JSON property bitbucketServerTriggerConfig

Returns:



1367
1368
1369
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1367

def bitbucket_server_trigger_config
  @bitbucket_server_trigger_config
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. - $LOCATION: the location/region 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:



1383
1384
1385
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1383

def build
  @build
end

#create_time ⇒ String

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

Returns:

  • (String) 


1388
1389
1390
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1388

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


1393
1394
1395
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1393

def description
  @description
end

#developer_connect_event_config ⇒ Google::Apis::CloudbuildV1::DeveloperConnectEventConfig

The configuration of a trigger that creates a build whenever an event from the DeveloperConnect API is received. Corresponds to the JSON property developerConnectEventConfig

Returns:



1399
1400
1401
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1399

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


1404
1405
1406
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1404

def disabled
  @disabled
end

#event_type ⇒ String

EventType allows the user to explicitly set the type of event to which this BuildTrigger should respond. This field will be validated against the rest of the configuration if it is set. Corresponds to the JSON property eventType

Returns:

  • (String) 


1412
1413
1414
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1412

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


1418
1419
1420
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1418

def filename
  @filename
end

#filter ⇒ String

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

Returns:

  • (String) 


1423
1424
1425
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1423

def filter
  @filter
end

#git_file_source ⇒ Google::Apis::CloudbuildV1::GitFileSource

GitFileSource describes a file within a (possibly remote) code repository. Corresponds to the JSON property gitFileSource

Returns:



1428
1429
1430
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1428

def git_file_source
  @git_file_source
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:



1434
1435
1436
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1434

def github
  @github
end

#gitlab_enterprise_events_config ⇒ Google::Apis::CloudbuildV1::GitLabEventsConfig

GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. Corresponds to the JSON property gitlabEnterpriseEventsConfig

Returns:



1440
1441
1442
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1440

def gitlab_enterprise_events_config
  @gitlab_enterprise_events_config
end

#id ⇒ String

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

Returns:

  • (String) 


1445
1446
1447
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1445

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


1455
1456
1457
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1455

def ignored_files
  @ignored_files
end

#include_build_logs ⇒ String

If set to INCLUDE_BUILD_LOGS_WITH_STATUS, log url will be shown on GitHub page when build status is final. Setting this field to INCLUDE_BUILD_LOGS_WITH_STATUS for non GitHub triggers results in INVALID_ARGUMENT error. Corresponds to the JSON property includeBuildLogs

Returns:

  • (String) 


1463
1464
1465
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1463

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


1473
1474
1475
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1473

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) 


1481
1482
1483
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1481

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:



1487
1488
1489
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1487

def pubsub_config
  @pubsub_config
end

#repository_event_config ⇒ Google::Apis::CloudbuildV1::RepositoryEventConfig

The configuration of a trigger that creates a build whenever an event from Repo API is received. Corresponds to the JSON property repositoryEventConfig

Returns:



1493
1494
1495
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1493

def repository_event_config
  @repository_event_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) 


1500
1501
1502
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1500

def resource_name
  @resource_name
end

#service_account ⇒ String

The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([ PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: projects/PROJECT_ID/serviceAccounts/ ACCOUNT_ID_OR_EMAIL` Corresponds to the JSON propertyserviceAccount`

Returns:

  • (String) 


1510
1511
1512
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1510

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:



1515
1516
1517
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1515

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


1521
1522
1523
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1521

def substitutions
  @substitutions
end

#tags ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1526
1527
1528
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1526

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:



1531
1532
1533
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1531

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:



1537
1538
1539
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1537

def webhook_config
  @webhook_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1544

def update!(**args)
  @approval_config = args[:approval_config] if args.key?(:approval_config)
  @autodetect = args[:autodetect] if args.key?(:autodetect)
  @bitbucket_server_trigger_config = args[:bitbucket_server_trigger_config] if args.key?(:bitbucket_server_trigger_config)
  @build = args[:build] if args.key?(:build)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @developer_connect_event_config = args[:developer_connect_event_config] if args.key?(:developer_connect_event_config)
  @disabled = args[:disabled] if args.key?(:disabled)
  @event_type = args[:event_type] if args.key?(:event_type)
  @filename = args[:filename] if args.key?(:filename)
  @filter = args[:filter] if args.key?(:filter)
  @git_file_source = args[:git_file_source] if args.key?(:git_file_source)
  @github = args[:github] if args.key?(:github)
  @gitlab_enterprise_events_config = args[:gitlab_enterprise_events_config] if args.key?(:gitlab_enterprise_events_config)
  @id = args[:id] if args.key?(:id)
  @ignored_files = args[:ignored_files] if args.key?(:ignored_files)
  @include_build_logs = args[:include_build_logs] if args.key?(:include_build_logs)
  @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)
  @repository_event_config = args[:repository_event_config] if args.key?(:repository_event_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