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

Class PipelineTask

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

PipelineTask defines a task in a 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
PipelineTask()

Method Summary

Modifier and Type	Method and Description
PipelineTask	clone()
String	getName() Name of the task.
List<Param>	getParams() Params is a list of parameter names and values.
Integer	getRetries() Retries represents how many times this task should be retried in case of task failure.
List<String>	getRunAfter() RunAfter is the list of PipelineTask names that should be executed before this Task executes.
TaskRef	getTaskRef() Reference to a specific instance of a task.
EmbeddedTask	getTaskSpec() Spec to instantiate this TaskRun.
String	getTimeout() Time after which the TaskRun times out.
List<WhenExpression>	getWhenExpressions() Conditions that need to be true for the task to run.
List<WorkspacePipelineTaskBinding>	getWorkspaces() Workspaces maps workspaces from the pipeline spec to the workspaces declared in the Task.
PipelineTask	set(String fieldName, Object value)
PipelineTask	setName(String name) Name of the task.
PipelineTask	setParams(List<Param> params) Params is a list of parameter names and values.
PipelineTask	setRetries(Integer retries) Retries represents how many times this task should be retried in case of task failure.
PipelineTask	setRunAfter(List<String> runAfter) RunAfter is the list of PipelineTask names that should be executed before this Task executes.
PipelineTask	setTaskRef(TaskRef taskRef) Reference to a specific instance of a task.
PipelineTask	setTaskSpec(EmbeddedTask taskSpec) Spec to instantiate this TaskRun.
PipelineTask	setTimeout(String timeout) Time after which the TaskRun times out.
PipelineTask	setWhenExpressions(List<WhenExpression> whenExpressions) Conditions that need to be true for the task to run.
PipelineTask	setWorkspaces(List<WorkspacePipelineTaskBinding> workspaces) Workspaces maps workspaces from the pipeline spec to the workspaces declared in the Task.

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

PipelineTask

public PipelineTask()

Method Detail

getName

public String getName()

Name of the task.

Returns:

value or null for none

setName

public PipelineTask setName(String name)

Name of the task.

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 PipelineTask setParams(List<Param> params)

Params is a list of parameter names and values.

Parameters:

params - params or null for none

getRetries

public Integer getRetries()

Retries represents how many times this task should be retried in case of task failure.

Returns:

value or null for none

setRetries

public PipelineTask setRetries(Integer retries)

Retries represents how many times this task should be retried in case of task failure.

Parameters:

retries - retries or null for none

getRunAfter

public List<String> getRunAfter()

RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)

Returns:

value or null for none

setRunAfter

public PipelineTask setRunAfter(List<String> runAfter)

RunAfter is the list of PipelineTask names that should be executed before this Task executes. (Used to force a specific ordering in graph execution.)

Parameters:

runAfter - runAfter or null for none

getTaskRef

public TaskRef getTaskRef()

Reference to a specific instance of a task.

Returns:

value or null for none

setTaskRef

public PipelineTask setTaskRef(TaskRef taskRef)

Reference to a specific instance of a task.

Parameters:

taskRef - taskRef or null for none

getTaskSpec

public EmbeddedTask getTaskSpec()

Spec to instantiate this TaskRun.

Returns:

value or null for none

setTaskSpec

public PipelineTask setTaskSpec(EmbeddedTask taskSpec)

Spec to instantiate this TaskRun.

Parameters:

taskSpec - taskSpec or null for none

getTimeout

public String getTimeout()

Time after which the TaskRun times out. Defaults to 1 hour. Specified TaskRun timeout should be less than 24h.

Returns:

value or null for none

setTimeout

public PipelineTask setTimeout(String timeout)

Time after which the TaskRun times out. Defaults to 1 hour. Specified TaskRun timeout should be less than 24h.

Parameters:

timeout - timeout or null for none

getWhenExpressions

public List<WhenExpression> getWhenExpressions()

Conditions that need to be true for the task to run.

Returns:

value or null for none

setWhenExpressions

public PipelineTask setWhenExpressions(List<WhenExpression> whenExpressions)

Conditions that need to be true for the task to run.

Parameters:

whenExpressions - whenExpressions or null for none

getWorkspaces

public List<WorkspacePipelineTaskBinding> getWorkspaces()

Workspaces maps workspaces from the pipeline spec to the workspaces declared in the Task.

Returns:

value or null for none

setWorkspaces

public PipelineTask setWorkspaces(List<WorkspacePipelineTaskBinding> workspaces)

Workspaces maps workspaces from the pipeline spec to the workspaces declared in the Task.

Parameters:

workspaces - workspaces or null for none

set

public PipelineTask set(String fieldName,
                        Object value)

Overrides:

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

clone

public PipelineTask clone()

Overrides:

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