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.



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

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


1476
1477
1478
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1476

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:



1482
1483
1484
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1482

def child_references
  @child_references
end

#completion_time ⇒ String

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

Returns:

  • (String) 


1487
1488
1489
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1487

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:



1492
1493
1494
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1492

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) 


1498
1499
1500
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1498

def create_time
  @create_time
end

#etag ⇒ String

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

Returns:

  • (String) 


1503
1504
1505
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1503

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) 


1509
1510
1511
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1509

def finally_start_time
  @finally_start_time
end

#name ⇒ String

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

Returns:

  • (String) 


1515
1516
1517
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1515

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:



1520
1521
1522
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1520

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:



1525
1526
1527
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1525

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) 


1530
1531
1532
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1530

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:



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

def pipeline_spec
  @pipeline_spec
end

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

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

Returns:



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

def resolved_pipeline_spec
  @resolved_pipeline_spec
end

#service_account ⇒ String

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

Returns:

  • (String) 


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

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:



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

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) 


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

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:



1562
1563
1564
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1562

def timeouts
  @timeouts
end

#uid ⇒ String

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

Returns:

  • (String) 


1567
1568
1569
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1567

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) 


1573
1574
1575
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1573

def update_time
  @update_time
end

#worker_pool ⇒ String

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

Returns:

  • (String) 


1578
1579
1580
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1578

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) 


1583
1584
1585
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1583

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:



1588
1589
1590
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1588

def workspaces
  @workspaces
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'lib/google/apis/cloudbuild_v2/classes.rb', line 1595

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)
  @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)
  @resolved_pipeline_spec = args[:resolved_pipeline_spec] if args.key?(:resolved_pipeline_spec)
  @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_pool = args[:worker_pool] if args.key?(:worker_pool)
  @workflow = args[:workflow] if args.key?(:workflow)
  @workspaces = args[:workspaces] if args.key?(:workspaces)
end