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.



1754
1755
1756
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1754

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


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

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:



1620
1621
1622
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1620

def child_references
  @child_references
end

#completion_time ⇒ String

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

Returns:

  • (String) 


1625
1626
1627
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1625

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:



1630
1631
1632
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1630

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) 


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

def create_time
  @create_time
end

#etag ⇒ String

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

Returns:

  • (String) 


1641
1642
1643
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1641

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) 


1647
1648
1649
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1647

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


1652
1653
1654
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1652

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) 


1658
1659
1660
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1658

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:



1663
1664
1665
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1663

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:



1668
1669
1670
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1668

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) 


1673
1674
1675
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1673

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:



1678
1679
1680
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1678

def pipeline_spec
  @pipeline_spec
end

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

Provenance configuration. Corresponds to the JSON property provenance

Returns:



1683
1684
1685
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1683

def provenance
  @provenance
end

#record ⇒ String

Output only. The Record of this PipelineRun. Format: projects/project/ locations/location/results/result_id/records/record_id` Corresponds to the JSON propertyrecord`

Returns:

  • (String) 


1689
1690
1691
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1689

def record
  @record
end

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

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

Returns:



1694
1695
1696
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1694

def resolved_pipeline_spec
  @resolved_pipeline_spec
end

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

Security configuration. Corresponds to the JSON property security

Returns:



1699
1700
1701
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1699

def security
  @security
end

#service_account ⇒ String

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

Returns:

  • (String) 


1704
1705
1706
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1704

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:



1710
1711
1712
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1710

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) 


1715
1716
1717
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1715

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:



1721
1722
1723
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1721

def timeouts
  @timeouts
end

#uid ⇒ String

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

Returns:

  • (String) 


1726
1727
1728
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1726

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) 


1732
1733
1734
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1732

def update_time
  @update_time
end

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

Configuration for the worker. Corresponds to the JSON property worker

Returns:



1737
1738
1739
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1737

def worker
  @worker
end

#worker_pool ⇒ String

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

Returns:

  • (String) 


1742
1743
1744
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1742

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) 


1747
1748
1749
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1747

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:



1752
1753
1754
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1752

def workspaces
  @workspaces
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1759

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)
  @record = args[:record] if args.key?(:record)
  @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