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

Class Step

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Step embeds the Container type, which allows it to include fields not provided by Container.

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

Method Summary

Modifier and Type	Method and Description
Step	clone()
List<String>	getArgs() Arguments to the entrypoint.
List<String>	getCommand() Entrypoint array.
List<EnvVar>	getEnv() List of environment variables to set in the container.
String	getImage() Docker image name.
String	getName() Name of the container specified as a DNS_LABEL.
String	getOnError() Optional.
List<Param>	getParams() Optional.
StepRef	getRef() Optional.
String	getScript() The contents of an executable file to execute.
SecurityContext	getSecurityContext() Optional.
String	getTimeout() Time after which the Step times out.
List<VolumeMount>	getVolumeMounts() Pod volumes to mount into the container's filesystem.
String	getWorkingDir() Container's working directory.
Step	set(String fieldName, Object value)
Step	setArgs(List<String> args) Arguments to the entrypoint.
Step	setCommand(List<String> command) Entrypoint array.
Step	setEnv(List<EnvVar> env) List of environment variables to set in the container.
Step	setImage(String image) Docker image name.
Step	setName(String name) Name of the container specified as a DNS_LABEL.
Step	setOnError(String onError) Optional.
Step	setParams(List<Param> params) Optional.
Step	setRef(StepRef ref) Optional.
Step	setScript(String script) The contents of an executable file to execute.
Step	setSecurityContext(SecurityContext securityContext) Optional.
Step	setTimeout(String timeout) Time after which the Step times out.
Step	setVolumeMounts(List<VolumeMount> volumeMounts) Pod volumes to mount into the container's filesystem.
Step	setWorkingDir(String workingDir) Container's working directory.

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

Step

public Step()

Method Detail

getArgs

public List<String> getArgs()

Arguments to the entrypoint.

Returns:

value or null for none

setArgs

public Step setArgs(List<String> args)

Arguments to the entrypoint.

Parameters:

args - args or null for none

getCommand

public List<String> getCommand()

Entrypoint array.

Returns:

value or null for none

setCommand

public Step setCommand(List<String> command)

Entrypoint array.

Parameters:

command - command or null for none

getEnv

public List<EnvVar> getEnv()

List of environment variables to set in the container.

Returns:

value or null for none

setEnv

public Step setEnv(List<EnvVar> env)

List of environment variables to set in the container.

Parameters:

env - env or null for none

getImage

public String getImage()

Docker image name.

Returns:

value or null for none

setImage

public Step setImage(String image)

Docker image name.

Parameters:

image - image or null for none

getName

public String getName()

Name of the container specified as a DNS_LABEL.

Returns:

value or null for none

setName

public Step setName(String name)

Name of the container specified as a DNS_LABEL.

Parameters:

name - name or null for none

getOnError

public String getOnError()

Optional. OnError defines the exiting behavior on error can be set to [ continue | stopAndFail ]

Returns:

value or null for none

setOnError

public Step setOnError(String onError)

Optional. OnError defines the exiting behavior on error can be set to [ continue | stopAndFail ]

Parameters:

onError - onError or null for none

getParams

public List<Param> getParams()

Optional. Optional parameters passed to the StepAction.

Returns:

value or null for none

setParams

public Step setParams(List<Param> params)

Optional. Optional parameters passed to the StepAction.

Parameters:

params - params or null for none

getRef

public StepRef getRef()

Optional. Optional reference to a remote StepAction.

Returns:

value or null for none

setRef

public Step setRef(StepRef ref)

Optional. Optional reference to a remote StepAction.

Parameters:

ref - ref or null for none

getScript

public String getScript()

The contents of an executable file to execute.

Returns:

value or null for none

setScript

public Step setScript(String script)

The contents of an executable file to execute.

Parameters:

script - script or null for none

getSecurityContext

public SecurityContext getSecurityContext()

Optional. SecurityContext defines the security options the Step should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ +optional

Returns:

value or null for none

setSecurityContext

public Step setSecurityContext(SecurityContext securityContext)

Optional. SecurityContext defines the security options the Step should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ +optional

Parameters:

securityContext - securityContext or null for none

getTimeout

public String getTimeout()

Time after which the Step times out. Defaults to never.

Returns:

value or null for none

setTimeout

public Step setTimeout(String timeout)

Time after which the Step times out. Defaults to never.

Parameters:

timeout - timeout or null for none

getVolumeMounts

public List<VolumeMount> getVolumeMounts()

Pod volumes to mount into the container's filesystem.

Returns:

value or null for none

setVolumeMounts

public Step setVolumeMounts(List<VolumeMount> volumeMounts)

Pod volumes to mount into the container's filesystem.

Parameters:

volumeMounts - volumeMounts or null for none

getWorkingDir

public String getWorkingDir()

Container's working directory.

Returns:

value or null for none

setWorkingDir

public Step setWorkingDir(String workingDir)

Container's working directory.

Parameters:

workingDir - workingDir or null for none

set

public Step set(String fieldName,
                Object value)

Overrides:

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

clone

public Step clone()

Overrides:

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