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.



1803
1804
1805
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1803

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


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

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:



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

def child_references
  @child_references
end

#completion_time ⇒ String

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

Returns:

  • (String) 


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

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:



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

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) 


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

def create_time
  @create_time
end

#etag ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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


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

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) 


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

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:



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

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:



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

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) 


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

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:



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

def pipeline_spec
  @pipeline_spec
end

#pipeline_spec_yaml ⇒ String

Output only. Inline pipelineSpec yaml string, used by workflow run requests. Corresponds to the JSON property pipelineSpecYaml

Returns:

  • (String) 


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

def pipeline_spec_yaml
  @pipeline_spec_yaml
end

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

Provenance configuration. Corresponds to the JSON property provenance

Returns:



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

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) 


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

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:



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

def resolved_pipeline_spec
  @resolved_pipeline_spec
end

#results ⇒ Array<Google::Apis::CloudbuildV2::PipelineRunResult>

Optional. Output only. List of results written out by the pipeline's containers Corresponds to the JSON property results

Returns:



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

def results
  @results
end

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

Security configuration. Corresponds to the JSON property security

Returns:



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

def security
  @security
end

#service_account ⇒ String

Service account used in the Pipeline. Deprecated; please use security. service_account instead. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


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

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:



1759
1760
1761
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1759

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) 


1764
1765
1766
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1764

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:



1770
1771
1772
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1770

def timeouts
  @timeouts
end

#uid ⇒ String

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

Returns:

  • (String) 


1775
1776
1777
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1775

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) 


1781
1782
1783
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1781

def update_time
  @update_time
end

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

Configuration for the worker. Corresponds to the JSON property worker

Returns:



1786
1787
1788
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1786

def worker
  @worker
end

#worker_pool ⇒ String

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

Returns:

  • (String) 


1791
1792
1793
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1791

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) 


1796
1797
1798
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1796

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:



1801
1802
1803
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1801

def workspaces
  @workspaces
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1808

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