Class: Google::Apis::CloudbuildV1::BuildOptions

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

Optional arguments to enable specific features of builds.

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

Returns a new instance of BuildOptions



418
419
420
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 418

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

Instance Attribute Details

#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 1000GB; builds that request more than the maximum are rejected with an error. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


348
349
350
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 348

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


357
358
359
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 357

def env
  @env
end

#log_streaming_option ⇒ String

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

Returns:

  • (String) 


363
364
365
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 363

def log_streaming_option
  @log_streaming_option
end

#logging ⇒ String

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

Returns:

  • (String) 


369
370
371
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 369

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) 


374
375
376
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 374

def machine_type
  @machine_type
end

#requested_verify_option ⇒ String

Requested verifiability options. Corresponds to the JSON property requestedVerifyOption

Returns:

  • (String) 


379
380
381
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 379

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


387
388
389
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 387

def secret_env
  @secret_env
end

#source_provenance_hash ⇒ Array<String>

Requested hash for SourceProvenance. Corresponds to the JSON property sourceProvenanceHash

Returns:

  • (Array<String>) 


392
393
394
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 392

def source_provenance_hash
  @source_provenance_hash
end

#substitution_option ⇒ String

Option to specify behavior when there is an error in the substitution checks. Corresponds to the JSON property substitutionOption

Returns:

  • (String) 


398
399
400
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 398

def substitution_option
  @substitution_option
end

#volumes ⇒ Array<Google::Apis::CloudbuildV1::Volume>

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:



409
410
411
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 409

def volumes
  @volumes
end

#worker_pool ⇒ String

Option to specify a WorkerPool for the build. User specifies the pool with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". This is an experimental field. Corresponds to the JSON property workerPool

Returns:

  • (String) 


416
417
418
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 416

def worker_pool
  @worker_pool
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'generated/google/apis/cloudbuild_v1/classes.rb', line 423

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