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.



1284
1285
1286
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1284

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:



1117
1118
1119
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1117

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) 


1124
1125
1126
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1124

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:



1131
1132
1133
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1131

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:



1147
1148
1149
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1147

def build
  @build
end

#create_time ⇒ String

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

Returns:

  • (String) 


1152
1153
1154
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1152

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


1157
1158
1159
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1157

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) 


1162
1163
1164
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1162

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) 


1170
1171
1172
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1170

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) 


1176
1177
1178
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1176

def filename
  @filename
end

#filter ⇒ String

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

Returns:

  • (String) 


1181
1182
1183
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1181

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:



1186
1187
1188
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1186

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:



1192
1193
1194
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1192

def github
  @github
end

#id ⇒ String

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

Returns:

  • (String) 


1197
1198
1199
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1197

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


1207
1208
1209
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1207

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) 


1215
1216
1217
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1215

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


1225
1226
1227
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1225

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) 


1233
1234
1235
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1233

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:



1239
1240
1241
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1239

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) 


1246
1247
1248
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1246

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


1255
1256
1257
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1255

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:



1260
1261
1262
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1260

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


1266
1267
1268
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1266

def substitutions
  @substitutions
end

#tags ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1271
1272
1273
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1271

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:



1276
1277
1278
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1276

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:



1282
1283
1284
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1282

def webhook_config
  @webhook_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/google/apis/cloudbuild_v1/classes.rb', line 1289

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