PipelineRun (Cloud Build API v2-rev20250814-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudbuild.v2.model.PipelineRun

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class PipelineRun
extends com.google.api.client.json.GenericJson
```
Message describing PipelineRun object
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Build API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

PipelineRun()

Constructors
Constructor and Description
`PipelineRun()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipelineRun`	`clone()`
`Map<String,String>`	`getAnnotations()` User annotations.
`List<ChildStatusReference>`	`getChildReferences()` Output only.
`String`	`getCompletionTime()` Output only.
`List<GoogleDevtoolsCloudbuildV2Condition>`	`getConditions()` Output only.
`String`	`getCreateTime()` Output only.
`String`	`getEtag()` Needed for declarative-friendly resources.
`String`	`getFinallyStartTime()` Output only.
`Map<String,String>`	`getGcbParams()` Output only.
`String`	`getName()` Output only.
`List<Param>`	`getParams()` Params is a list of parameter names and values.
`PipelineRef`	`getPipelineRef()` PipelineRef refer to a specific instance of a Pipeline.
`String`	`getPipelineRunStatus()` Pipelinerun status the user can provide.
`PipelineSpec`	`getPipelineSpec()` PipelineSpec defines the desired state of Pipeline.
`String`	`getPipelineSpecYaml()` Output only.
`Provenance`	`getProvenance()` Optional.
`String`	`getRecord()` Output only.
`PipelineSpec`	`getResolvedPipelineSpec()` Output only.
`List<PipelineRunResult>`	`getResults()` Optional.
`Security`	`getSecurity()` Optional.
`String`	`getServiceAccount()` Service account used in the Pipeline.
`List<SkippedTask>`	`getSkippedTasks()` Output only.
`String`	`getStartTime()` Output only.
`TimeoutFields`	`getTimeouts()` Time after which the Pipeline times out.
`String`	`getUid()` Output only.
`String`	`getUpdateTime()` Output only.
`Worker`	`getWorker()` Optional.
`String`	`getWorkerPool()` Output only.
`String`	`getWorkflow()` Output only.
`List<WorkspaceBinding>`	`getWorkspaces()` Workspaces is a list of WorkspaceBindings from volumes to workspaces.
`PipelineRun`	`set(String fieldName, Object value)`
`PipelineRun`	`setAnnotations(Map<String,String> annotations)` User annotations.
`PipelineRun`	`setChildReferences(List<ChildStatusReference> childReferences)` Output only.
`PipelineRun`	`setCompletionTime(String completionTime)` Output only.
`PipelineRun`	`setConditions(List<GoogleDevtoolsCloudbuildV2Condition> conditions)` Output only.
`PipelineRun`	`setCreateTime(String createTime)` Output only.
`PipelineRun`	`setEtag(String etag)` Needed for declarative-friendly resources.
`PipelineRun`	`setFinallyStartTime(String finallyStartTime)` Output only.
`PipelineRun`	`setGcbParams(Map<String,String> gcbParams)` Output only.
`PipelineRun`	`setName(String name)` Output only.
`PipelineRun`	`setParams(List<Param> params)` Params is a list of parameter names and values.
`PipelineRun`	`setPipelineRef(PipelineRef pipelineRef)` PipelineRef refer to a specific instance of a Pipeline.
`PipelineRun`	`setPipelineRunStatus(String pipelineRunStatus)` Pipelinerun status the user can provide.
`PipelineRun`	`setPipelineSpec(PipelineSpec pipelineSpec)` PipelineSpec defines the desired state of Pipeline.
`PipelineRun`	`setPipelineSpecYaml(String pipelineSpecYaml)` Output only.
`PipelineRun`	`setProvenance(Provenance provenance)` Optional.
`PipelineRun`	`setRecord(String record)` Output only.
`PipelineRun`	`setResolvedPipelineSpec(PipelineSpec resolvedPipelineSpec)` Output only.
`PipelineRun`	`setResults(List<PipelineRunResult> results)` Optional.
`PipelineRun`	`setSecurity(Security security)` Optional.
`PipelineRun`	`setServiceAccount(String serviceAccount)` Service account used in the Pipeline.
`PipelineRun`	`setSkippedTasks(List<SkippedTask> skippedTasks)` Output only.
`PipelineRun`	`setStartTime(String startTime)` Output only.
`PipelineRun`	`setTimeouts(TimeoutFields timeouts)` Time after which the Pipeline times out.
`PipelineRun`	`setUid(String uid)` Output only.
`PipelineRun`	`setUpdateTime(String updateTime)` Output only.
`PipelineRun`	`setWorker(Worker worker)` Optional.
`PipelineRun`	`setWorkerPool(String workerPool)` Output only.
`PipelineRun`	`setWorkflow(String workflow)` Output only.
`PipelineRun`	`setWorkspaces(List<WorkspaceBinding> workspaces)` Workspaces is a list of WorkspaceBindings from volumes to workspaces.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - PipelineRun
```
public PipelineRun()
```
- Method Detail
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    User annotations. See https://google.aip.dev/128#annotations
    
    Returns:
    
    value or null for none
  - setAnnotations
```
public PipelineRun setAnnotations(Map<String,String> annotations)
```
    User annotations. See https://google.aip.dev/128#annotations
    
    Parameters:
    
    annotations - annotations or null for none
  - getChildReferences
```
public List<ChildStatusReference> getChildReferences()
```
    Output only. List of TaskRun and Run names and PipelineTask names for children of this PipelineRun.
    
    Returns:
    
    value or null for none
  - setChildReferences
```
public PipelineRun setChildReferences(List<ChildStatusReference> childReferences)
```
    Output only. List of TaskRun and Run names and PipelineTask names for children of this PipelineRun.
    
    Parameters:
    
    childReferences - childReferences or null for none
  - getCompletionTime
```
public String getCompletionTime()
```
    Output only. Time the pipeline completed.
    
    Returns:
    
    value or null for none
  - setCompletionTime
```
public PipelineRun setCompletionTime(String completionTime)
```
    Output only. Time the pipeline completed.
    
    Parameters:
    
    completionTime - completionTime or null for none
  - getConditions
```
public List<GoogleDevtoolsCloudbuildV2Condition> getConditions()
```
    Output only. Kubernetes Conditions convention for PipelineRun status and error.
    
    Returns:
    
    value or null for none
  - setConditions
```
public PipelineRun setConditions(List<GoogleDevtoolsCloudbuildV2Condition> conditions)
```
    Output only. Kubernetes Conditions convention for PipelineRun status and error.
    
    Parameters:
    
    conditions - conditions or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Time at which the request to create the `PipelineRun` was received.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public PipelineRun setCreateTime(String createTime)
```
    Output only. Time at which the request to create the `PipelineRun` was received.
    
    Parameters:
    
    createTime - createTime or null for none
  - getEtag
```
public String getEtag()
```
    Needed for declarative-friendly resources.
    
    Returns:
    
    value or null for none
  - setEtag
```
public PipelineRun setEtag(String etag)
```
    Needed for declarative-friendly resources.
    
    Parameters:
    
    etag - etag or null for none
  - getFinallyStartTime
```
public String getFinallyStartTime()
```
    Output only. FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed. +optional
    
    Returns:
    
    value or null for none
  - setFinallyStartTime
```
public PipelineRun setFinallyStartTime(String finallyStartTime)
```
    Output only. FinallyStartTime is when all non-finally tasks have been completed and only finally tasks are being executed. +optional
    
    Parameters:
    
    finallyStartTime - finallyStartTime or null for none
  - getGcbParams
```
public Map<String,String> getGcbParams()
```
    Output only. GCB default params.
    
    Returns:
    
    value or null for none
  - setGcbParams
```
public PipelineRun setGcbParams(Map<String,String> gcbParams)
```
    Output only. GCB default params.
    
    Parameters:
    
    gcbParams - gcbParams or null for none
  - getName
```
public String getName()
```
    Output only. The `PipelineRun` name with format `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}`
    
    Returns:
    
    value or null for none
  - setName
```
public PipelineRun setName(String name)
```
    Output only. The `PipelineRun` name with format `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}`
    
    Parameters:
    
    name - name or null for none
  - getParams
```
public List<Param> getParams()
```
    Params is a list of parameter names and values.
    
    Returns:
    
    value or null for none
  - setParams
```
public PipelineRun setParams(List<Param> params)
```
    Params is a list of parameter names and values.
    
    Parameters:
    
    params - params or null for none
  - getPipelineRef
```
public PipelineRef getPipelineRef()
```
    PipelineRef refer to a specific instance of a Pipeline.
    
    Returns:
    
    value or null for none
  - setPipelineRef
```
public PipelineRun setPipelineRef(PipelineRef pipelineRef)
```
    PipelineRef refer to a specific instance of a Pipeline.
    
    Parameters:
    
    pipelineRef - pipelineRef or null for none
  - getPipelineRunStatus
```
public String getPipelineRunStatus()
```
    Pipelinerun status the user can provide. Used for cancellation.
    
    Returns:
    
    value or null for none
  - setPipelineRunStatus
```
public PipelineRun setPipelineRunStatus(String pipelineRunStatus)
```
    Pipelinerun status the user can provide. Used for cancellation.
    
    Parameters:
    
    pipelineRunStatus - pipelineRunStatus or null for none
  - getPipelineSpec
```
public PipelineSpec getPipelineSpec()
```
    PipelineSpec defines the desired state of Pipeline.
    
    Returns:
    
    value or null for none
  - setPipelineSpec
```
public PipelineRun setPipelineSpec(PipelineSpec pipelineSpec)
```
    PipelineSpec defines the desired state of Pipeline.
    
    Parameters:
    
    pipelineSpec - pipelineSpec or null for none
  - getPipelineSpecYaml
```
public String getPipelineSpecYaml()
```
    Output only. Inline pipelineSpec yaml string, used by workflow run requests.
    
    Returns:
    
    value or null for none
  - setPipelineSpecYaml
```
public PipelineRun setPipelineSpecYaml(String pipelineSpecYaml)
```
    Output only. Inline pipelineSpec yaml string, used by workflow run requests.
    
    Parameters:
    
    pipelineSpecYaml - pipelineSpecYaml or null for none
  - getProvenance
```
public Provenance getProvenance()
```
    Optional. Provenance configuration.
    
    Returns:
    
    value or null for none
  - setProvenance
```
public PipelineRun setProvenance(Provenance provenance)
```
    Optional. Provenance configuration.
    
    Parameters:
    
    provenance - provenance or null for none
  - getRecord
```
public String getRecord()
```
    Output only. The `Record` of this `PipelineRun`. Format: `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}`
    
    Returns:
    
    value or null for none
  - setRecord
```
public PipelineRun setRecord(String record)
```
    Output only. The `Record` of this `PipelineRun`. Format: `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}`
    
    Parameters:
    
    record - record or null for none
  - getResolvedPipelineSpec
```
public PipelineSpec getResolvedPipelineSpec()
```
    Output only. The exact PipelineSpec used to instantiate the run.
    
    Returns:
    
    value or null for none
  - setResolvedPipelineSpec
```
public PipelineRun setResolvedPipelineSpec(PipelineSpec resolvedPipelineSpec)
```
    Output only. The exact PipelineSpec used to instantiate the run.
    
    Parameters:
    
    resolvedPipelineSpec - resolvedPipelineSpec or null for none
  - getResults
```
public List<PipelineRunResult> getResults()
```
    Optional. Output only. List of results written out by the pipeline's containers
    
    Returns:
    
    value or null for none
  - setResults
```
public PipelineRun setResults(List<PipelineRunResult> results)
```
    Optional. Output only. List of results written out by the pipeline's containers
    
    Parameters:
    
    results - results or null for none
  - getSecurity
```
public Security getSecurity()
```
    Optional. Security configuration.
    
    Returns:
    
    value or null for none
  - setSecurity
```
public PipelineRun setSecurity(Security security)
```
    Optional. Security configuration.
    
    Parameters:
    
    security - security or null for none
  - getServiceAccount
```
public String getServiceAccount()
```
    Service account used in the Pipeline. Deprecated; please use security.service_account instead.
    
    Returns:
    
    value or null for none
  - setServiceAccount
```
public PipelineRun setServiceAccount(String serviceAccount)
```
    Service account used in the Pipeline. Deprecated; please use security.service_account instead.
    
    Parameters:
    
    serviceAccount - serviceAccount or null for none
  - getSkippedTasks
```
public List<SkippedTask> getSkippedTasks()
```
    Output only. List of tasks that were skipped due to when expressions evaluating to false.
    
    Returns:
    
    value or null for none
  - setSkippedTasks
```
public PipelineRun setSkippedTasks(List<SkippedTask> skippedTasks)
```
    Output only. List of tasks that were skipped due to when expressions evaluating to false.
    
    Parameters:
    
    skippedTasks - skippedTasks or null for none
  - getStartTime
```
public String getStartTime()
```
    Output only. Time the pipeline is actually started.
    
    Returns:
    
    value or null for none
  - setStartTime
```
public PipelineRun setStartTime(String startTime)
```
    Output only. Time the pipeline is actually started.
    
    Parameters:
    
    startTime - startTime or null for none
  - getTimeouts
```
public TimeoutFields getTimeouts()
```
    Time after which the Pipeline times out. Currently three keys are accepted in the map pipeline, tasks and finally with Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally
    
    Returns:
    
    value or null for none
  - setTimeouts
```
public PipelineRun setTimeouts(TimeoutFields timeouts)
```
    Time after which the Pipeline times out. Currently three keys are accepted in the map pipeline, tasks and finally with Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally
    
    Parameters:
    
    timeouts - timeouts or null for none
  - getUid
```
public String getUid()
```
    Output only. A unique identifier for the `PipelineRun`.
    
    Returns:
    
    value or null for none
  - setUid
```
public PipelineRun setUid(String uid)
```
    Output only. A unique identifier for the `PipelineRun`.
    
    Parameters:
    
    uid - uid or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. Time at which the request to update the `PipelineRun` was received.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public PipelineRun setUpdateTime(String updateTime)
```
    Output only. Time at which the request to update the `PipelineRun` was received.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - getWorker
```
public Worker getWorker()
```
    Optional. Worker configuration.
    
    Returns:
    
    value or null for none
  - setWorker
```
public PipelineRun setWorker(Worker worker)
```
    Optional. Worker configuration.
    
    Parameters:
    
    worker - worker or null for none
  - getWorkerPool
```
public String getWorkerPool()
```
    Output only. The WorkerPool used to run this PipelineRun.
    
    Returns:
    
    value or null for none
  - setWorkerPool
```
public PipelineRun setWorkerPool(String workerPool)
```
    Output only. The WorkerPool used to run this PipelineRun.
    
    Parameters:
    
    workerPool - workerPool or null for none
  - getWorkflow
```
public String getWorkflow()
```
    Output only. The Workflow used to create this PipelineRun.
    
    Returns:
    
    value or null for none
  - setWorkflow
```
public PipelineRun setWorkflow(String workflow)
```
    Output only. The Workflow used to create this PipelineRun.
    
    Parameters:
    
    workflow - workflow or null for none
  - getWorkspaces
```
public List<WorkspaceBinding> getWorkspaces()
```
    Workspaces is a list of WorkspaceBindings from volumes to workspaces.
    
    Returns:
    
    value or null for none
  - setWorkspaces
```
public PipelineRun setWorkspaces(List<WorkspaceBinding> workspaces)
```
    Workspaces is a list of WorkspaceBindings from volumes to workspaces.
    
    Parameters:
    
    workspaces - workspaces or null for none
  - set
```
public PipelineRun set(String fieldName,
                       Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public PipelineRun clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class PipelineRun

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

PipelineRun

Method Detail

getAnnotations

setAnnotations

getChildReferences

setChildReferences

getCompletionTime

setCompletionTime

getConditions

setConditions

getCreateTime

setCreateTime

getEtag

setEtag

getFinallyStartTime

setFinallyStartTime

getGcbParams

setGcbParams

getName

setName

getParams

setParams

getPipelineRef

setPipelineRef

getPipelineRunStatus

setPipelineRunStatus

getPipelineSpec

setPipelineSpec

getPipelineSpecYaml

setPipelineSpecYaml

getProvenance

setProvenance

getRecord

setRecord

getResolvedPipelineSpec

setResolvedPipelineSpec

getResults

setResults

getSecurity

setSecurity

getServiceAccount

setServiceAccount

getSkippedTasks

setSkippedTasks

getStartTime

setStartTime

getTimeouts

setTimeouts

getUid

setUid

getUpdateTime

setUpdateTime

getWorker

setWorker

getWorkerPool

setWorkerPool

getWorkflow

setWorkflow

getWorkspaces

setWorkspaces

set

clone