Class: Google::Apis::RunV2::GoogleDevtoolsCloudbuildV1BuildOptions

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

Overview

Optional arguments to enable specific features of builds.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleDevtoolsCloudbuildV1BuildOptions

Returns a new instance of GoogleDevtoolsCloudbuildV1BuildOptions.



5296
5297
5298
 
# File 'lib/google/apis/run_v2/classes.rb', line 5296

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

Instance Attribute Details

#automap_substitutions ⇒ Boolean Also known as: automap_substitutions?

Option to include built-in and custom substitutions as env variables for all build steps. Corresponds to the JSON property automapSubstitutions

Returns:

  • (Boolean) 


5187
5188
5189
 
# File 'lib/google/apis/run_v2/classes.rb', line 5187

def automap_substitutions
  @automap_substitutions
end

#default_logs_bucket_behavior ⇒ String

Optional. Option to specify how default logs buckets are setup. Corresponds to the JSON property defaultLogsBucketBehavior

Returns:

  • (String) 


5193
5194
5195
 
# File 'lib/google/apis/run_v2/classes.rb', line 5193

def default_logs_bucket_behavior
  @default_logs_bucket_behavior
end

#disk_size_gb ⇒ Fixnum

Requested disk size for the VM that runs the build. Note that this is NOT " disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


5203
5204
5205
 
# File 'lib/google/apis/run_v2/classes.rb', line 5203

def disk_size_gb
  @disk_size_gb
end

#dynamic_substitutions ⇒ Boolean Also known as: dynamic_substitutions?

Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file. Corresponds to the JSON property dynamicSubstitutions

Returns:

  • (Boolean) 


5210
5211
5212
 
# File 'lib/google/apis/run_v2/classes.rb', line 5210

def dynamic_substitutions
  @dynamic_substitutions
end

#enable_structured_logging ⇒ Boolean Also known as: enable_structured_logging?

Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs. Corresponds to the JSON property enableStructuredLogging

Returns:

  • (Boolean) 


5217
5218
5219
 
# File 'lib/google/apis/run_v2/classes.rb', line 5217

def enable_structured_logging
  @enable_structured_logging
end

#env ⇒ Array<String>

A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value " VALUE". Corresponds to the JSON property env

Returns:

  • (Array<String>) 


5227
5228
5229
 
# File 'lib/google/apis/run_v2/classes.rb', line 5227

def env
  @env
end

#log_streaming_option ⇒ String

Option to define build log streaming behavior to Cloud Storage. Corresponds to the JSON property logStreamingOption

Returns:

  • (String) 


5232
5233
5234
 
# File 'lib/google/apis/run_v2/classes.rb', line 5232

def log_streaming_option
  @log_streaming_option
end

#logging ⇒ String

Option to specify the logging mode, which determines if and where build logs are stored. Corresponds to the JSON property logging

Returns:

  • (String) 


5238
5239
5240
 
# File 'lib/google/apis/run_v2/classes.rb', line 5238

def logging
  @logging
end

#machine_type ⇒ String

Compute Engine machine type on which to run the build. Corresponds to the JSON property machineType

Returns:

  • (String) 


5243
5244
5245
 
# File 'lib/google/apis/run_v2/classes.rb', line 5243

def machine_type
  @machine_type
end

#pool ⇒ Google::Apis::RunV2::GoogleDevtoolsCloudbuildV1PoolOption

Details about how a build should be executed on a WorkerPool. See running builds in a private pool for more information. Corresponds to the JSON property pool

Returns:



5250
5251
5252
 
# File 'lib/google/apis/run_v2/classes.rb', line 5250

def pool
  @pool
end

#pubsub_topic ⇒ String

Optional. Option to specify the Pub/Sub topic to receive build status updates. Corresponds to the JSON property pubsubTopic

Returns:

  • (String) 


5255
5256
5257
 
# File 'lib/google/apis/run_v2/classes.rb', line 5255

def pubsub_topic
  @pubsub_topic
end

#requested_verify_option ⇒ String

Requested verifiability options. Corresponds to the JSON property requestedVerifyOption

Returns:

  • (String) 


5260
5261
5262
 
# File 'lib/google/apis/run_v2/classes.rb', line 5260

def requested_verify_option
  @requested_verify_option
end

#secret_env ⇒ Array<String>

A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret. These variables will be available to all build steps in this build. Corresponds to the JSON property secretEnv

Returns:

  • (Array<String>) 


5267
5268
5269
 
# File 'lib/google/apis/run_v2/classes.rb', line 5267

def secret_env
  @secret_env
end

#source_provenance_hash ⇒ Array<String>

Requested hash for SourceProvenance. Corresponds to the JSON property sourceProvenanceHash

Returns:

  • (Array<String>) 


5272
5273
5274
 
# File 'lib/google/apis/run_v2/classes.rb', line 5272

def source_provenance_hash
  @source_provenance_hash
end

#substitution_option ⇒ String

Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file. Corresponds to the JSON property substitutionOption

Returns:

  • (String) 


5279
5280
5281
 
# File 'lib/google/apis/run_v2/classes.rb', line 5279

def substitution_option
  @substitution_option
end

#volumes ⇒ Array<Google::Apis::RunV2::GoogleDevtoolsCloudbuildV1Volume>

Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. Corresponds to the JSON property volumes

Returns:



5289
5290
5291
 
# File 'lib/google/apis/run_v2/classes.rb', line 5289

def volumes
  @volumes
end

#worker_pool ⇒ String

This field deprecated; please use pool.name instead. Corresponds to the JSON property workerPool

Returns:

  • (String) 


5294
5295
5296
 
# File 'lib/google/apis/run_v2/classes.rb', line 5294

def worker_pool
  @worker_pool
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
 
# File 'lib/google/apis/run_v2/classes.rb', line 5301

def update!(**args)
  @automap_substitutions = args[:automap_substitutions] if args.key?(:automap_substitutions)
  @default_logs_bucket_behavior = args[:default_logs_bucket_behavior] if args.key?(:default_logs_bucket_behavior)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @dynamic_substitutions = args[:dynamic_substitutions] if args.key?(:dynamic_substitutions)
  @enable_structured_logging = args[:enable_structured_logging] if args.key?(:enable_structured_logging)
  @env = args[:env] if args.key?(:env)
  @log_streaming_option = args[:log_streaming_option] if args.key?(:log_streaming_option)
  @logging = args[:logging] if args.key?(:logging)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @pool = args[:pool] if args.key?(:pool)
  @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
  @requested_verify_option = args[:requested_verify_option] if args.key?(:requested_verify_option)
  @secret_env = args[:secret_env] if args.key?(:secret_env)
  @source_provenance_hash = args[:source_provenance_hash] if args.key?(:source_provenance_hash)
  @substitution_option = args[:substitution_option] if args.key?(:substitution_option)
  @volumes = args[:volumes] if args.key?(:volumes)
  @worker_pool = args[:worker_pool] if args.key?(:worker_pool)
end