com.google.api.services.cloudbuild.v2.model

Class PipelineSpec

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.PipelineSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PipelineSpec
extends com.google.api.client.json.GenericJson

PipelineSpec defines the desired state of Pipeline.

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

Method Summary

Modifier and Type	Method and Description
PipelineSpec	clone()
List<PipelineTask>	getFinallyTasks() List of Tasks that execute just before leaving the Pipeline i.e.
String	getGeneratedYaml() Output only.
List<ParamSpec>	getParams() List of parameters.
List<PipelineResult>	getResults() Optional.
List<PipelineTask>	getTasks() List of Tasks that execute when this Pipeline is run.
List<PipelineWorkspaceDeclaration>	getWorkspaces() Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.
PipelineSpec	set(String fieldName, Object value)
PipelineSpec	setFinallyTasks(List<PipelineTask> finallyTasks) List of Tasks that execute just before leaving the Pipeline i.e.
PipelineSpec	setGeneratedYaml(String generatedYaml) Output only.
PipelineSpec	setParams(List<ParamSpec> params) List of parameters.
PipelineSpec	setResults(List<PipelineResult> results) Optional.
PipelineSpec	setTasks(List<PipelineTask> tasks) List of Tasks that execute when this Pipeline is run.
PipelineSpec	setWorkspaces(List<PipelineWorkspaceDeclaration> workspaces) Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.

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

PipelineSpec

public PipelineSpec()

Method Detail

getFinallyTasks

public List<PipelineTask> getFinallyTasks()

List of Tasks that execute just before leaving the Pipeline i.e. either after all Tasks are finished executing successfully or after a failure which would result in ending the Pipeline.

Returns:

value or null for none

setFinallyTasks

public PipelineSpec setFinallyTasks(List<PipelineTask> finallyTasks)

List of Tasks that execute just before leaving the Pipeline i.e. either after all Tasks are finished executing successfully or after a failure which would result in ending the Pipeline.

Parameters:

finallyTasks - finallyTasks or null for none

getGeneratedYaml

public String getGeneratedYaml()

Output only. auto-generated yaml that is output only for display purpose for workflows using pipeline_spec, used by UI/gcloud cli for Workflows.

Returns:

value or null for none

setGeneratedYaml

public PipelineSpec setGeneratedYaml(String generatedYaml)

Output only. auto-generated yaml that is output only for display purpose for workflows using pipeline_spec, used by UI/gcloud cli for Workflows.

Parameters:

generatedYaml - generatedYaml or null for none

getParams

public List<ParamSpec> getParams()

List of parameters.

Returns:

value or null for none

setParams

public PipelineSpec setParams(List<ParamSpec> params)

List of parameters.

Parameters:

params - params or null for none

getResults

public List<PipelineResult> getResults()

Optional. Output only. List of results written out by the pipeline's containers

Returns:

value or null for none

setResults

public PipelineSpec setResults(List<PipelineResult> results)

Optional. Output only. List of results written out by the pipeline's containers

Parameters:

results - results or null for none

getTasks

public List<PipelineTask> getTasks()

List of Tasks that execute when this Pipeline is run.

Returns:

value or null for none

setTasks

public PipelineSpec setTasks(List<PipelineTask> tasks)

List of Tasks that execute when this Pipeline is run.

Parameters:

tasks - tasks or null for none

getWorkspaces

public List<PipelineWorkspaceDeclaration> getWorkspaces()

Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.

Returns:

value or null for none

setWorkspaces

public PipelineSpec setWorkspaces(List<PipelineWorkspaceDeclaration> workspaces)

Workspaces declares a set of named workspaces that are expected to be provided by a PipelineRun.

Parameters:

workspaces - workspaces or null for none

set

public PipelineSpec set(String fieldName,
                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public PipelineSpec clone()

Overrides:

clone in class com.google.api.client.json.GenericJson