Class: Google::Apis::CloudbuildV2::PipelineRun

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

Overview

Message describing PipelineRun object

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PipelineRun

Returns a new instance of PipelineRun.



1635
1636
1637
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1635

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

User annotations. See https://google.aip.dev/128#annotations Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


1501
1502
1503
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1501

def annotations
  @annotations
end

#child_references ⇒ Array<Google::Apis::CloudbuildV2::ChildStatusReference>

Output only. List of TaskRun and Run names and PipelineTask names for children of this PipelineRun. Corresponds to the JSON property childReferences

Returns:



1507
1508
1509
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1507

def child_references
  @child_references
end

#completion_time ⇒ String

Output only. Time the pipeline completed. Corresponds to the JSON property completionTime

Returns:

  • (String) 


1512
1513
1514
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1512

def completion_time
  @completion_time
end

#conditions ⇒ Array<Google::Apis::CloudbuildV2::GoogleDevtoolsCloudbuildV2Condition>

Output only. Kubernetes Conditions convention for PipelineRun status and error. Corresponds to the JSON property conditions

Returns:



1517
1518
1519
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1517

def conditions
  @conditions
end

#create_time ⇒ String

Output only. Time at which the request to create the PipelineRun was received. Corresponds to the JSON property createTime

Returns:

  • (String) 


1523
1524
1525
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1523

def create_time
  @create_time
end

#etag ⇒ String

Needed for declarative-friendly resources. Corresponds to the JSON property etag

Returns:

  • (String) 


1528
1529
1530
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1528

def etag
  @etag
end

#finally_start_time ⇒ String

Output only. FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed. +optional Corresponds to the JSON property finallyStartTime

Returns:

  • (String) 


1534
1535
1536
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1534

def finally_start_time
  @finally_start_time
end

#gcb_params ⇒ Hash<String,String>

Output only. GCB default params. Corresponds to the JSON property gcbParams

Returns:

  • (Hash<String,String>) 


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

def gcb_params
  @gcb_params
end

#name ⇒ String

Output only. The PipelineRun name with format projects/project/locations/ location/pipelineRuns/pipeline_run` Corresponds to the JSON propertyname`

Returns:

  • (String) 


1545
1546
1547
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1545

def name
  @name
end

#params ⇒ Array<Google::Apis::CloudbuildV2::Param>

Params is a list of parameter names and values. Corresponds to the JSON property params

Returns:



1550
1551
1552
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1550

def params
  @params
end

#pipeline_ref ⇒ Google::Apis::CloudbuildV2::PipelineRef

PipelineRef can be used to refer to a specific instance of a Pipeline. Corresponds to the JSON property pipelineRef

Returns:



1555
1556
1557
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1555

def pipeline_ref
  @pipeline_ref
end

#pipeline_run_status ⇒ String

Pipelinerun status the user can provide. Used for cancellation. Corresponds to the JSON property pipelineRunStatus

Returns:

  • (String) 


1560
1561
1562
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1560

def pipeline_run_status
  @pipeline_run_status
end

#pipeline_spec ⇒ Google::Apis::CloudbuildV2::PipelineSpec

PipelineSpec defines the desired state of Pipeline. Corresponds to the JSON property pipelineSpec

Returns:



1565
1566
1567
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1565

def pipeline_spec
  @pipeline_spec
end

#provenance ⇒ Google::Apis::CloudbuildV2::Provenance

Provenance configuration. Corresponds to the JSON property provenance

Returns:



1570
1571
1572
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1570

def provenance
  @provenance
end

#resolved_pipeline_spec ⇒ Google::Apis::CloudbuildV2::PipelineSpec

PipelineSpec defines the desired state of Pipeline. Corresponds to the JSON property resolvedPipelineSpec

Returns:



1575
1576
1577
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1575

def resolved_pipeline_spec
  @resolved_pipeline_spec
end

#security ⇒ Google::Apis::CloudbuildV2::Security

Security configuration. Corresponds to the JSON property security

Returns:



1580
1581
1582
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1580

def security
  @security
end

#service_account ⇒ String

Service account used in the Pipeline. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


1585
1586
1587
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1585

def 
  @service_account
end

#skipped_tasks ⇒ Array<Google::Apis::CloudbuildV2::SkippedTask>

Output only. List of tasks that were skipped due to when expressions evaluating to false. Corresponds to the JSON property skippedTasks

Returns:



1591
1592
1593
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1591

def skipped_tasks
  @skipped_tasks
end

#start_time ⇒ String

Output only. Time the pipeline is actually started. Corresponds to the JSON property startTime

Returns:

  • (String) 


1596
1597
1598
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1596

def start_time
  @start_time
end

#timeouts ⇒ Google::Apis::CloudbuildV2::TimeoutFields

TimeoutFields allows granular specification of pipeline, task, and finally timeouts Corresponds to the JSON property timeouts

Returns:



1602
1603
1604
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1602

def timeouts
  @timeouts
end

#uid ⇒ String

Output only. A unique identifier for the PipelineRun. Corresponds to the JSON property uid

Returns:

  • (String) 


1607
1608
1609
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1607

def uid
  @uid
end

#update_time ⇒ String

Output only. Time at which the request to update the PipelineRun was received. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1613
1614
1615
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1613

def update_time
  @update_time
end

#worker ⇒ Google::Apis::CloudbuildV2::Worker

Configuration for the worker. Corresponds to the JSON property worker

Returns:



1618
1619
1620
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1618

def worker
  @worker
end

#worker_pool ⇒ String

Output only. The WorkerPool used to run this PipelineRun. Corresponds to the JSON property workerPool

Returns:

  • (String) 


1623
1624
1625
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1623

def worker_pool
  @worker_pool
end

#workflow ⇒ String

Output only. The Workflow used to create this PipelineRun. Corresponds to the JSON property workflow

Returns:

  • (String) 


1628
1629
1630
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1628

def workflow
  @workflow
end

#workspaces ⇒ Array<Google::Apis::CloudbuildV2::WorkspaceBinding>

Workspaces is a list of WorkspaceBindings from volumes to workspaces. Corresponds to the JSON property workspaces

Returns:



1633
1634
1635
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1633

def workspaces
  @workspaces
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1640

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @child_references = args[:child_references] if args.key?(:child_references)
  @completion_time = args[:completion_time] if args.key?(:completion_time)
  @conditions = args[:conditions] if args.key?(:conditions)
  @create_time = args[:create_time] if args.key?(:create_time)
  @etag = args[:etag] if args.key?(:etag)
  @finally_start_time = args[:finally_start_time] if args.key?(:finally_start_time)
  @gcb_params = args[:gcb_params] if args.key?(:gcb_params)
  @name = args[:name] if args.key?(:name)
  @params = args[:params] if args.key?(:params)
  @pipeline_ref = args[:pipeline_ref] if args.key?(:pipeline_ref)
  @pipeline_run_status = args[:pipeline_run_status] if args.key?(:pipeline_run_status)
  @pipeline_spec = args[:pipeline_spec] if args.key?(:pipeline_spec)
  @provenance = args[:provenance] if args.key?(:provenance)
  @resolved_pipeline_spec = args[:resolved_pipeline_spec] if args.key?(:resolved_pipeline_spec)
  @security = args[:security] if args.key?(:security)
  @service_account = args[:service_account] if args.key?(:service_account)
  @skipped_tasks = args[:skipped_tasks] if args.key?(:skipped_tasks)
  @start_time = args[:start_time] if args.key?(:start_time)
  @timeouts = args[:timeouts] if args.key?(:timeouts)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @worker = args[:worker] if args.key?(:worker)
  @worker_pool = args[:worker_pool] if args.key?(:worker_pool)
  @workflow = args[:workflow] if args.key?(:workflow)
  @workspaces = args[:workspaces] if args.key?(:workspaces)
end