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

Class Sidecar

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Sidecars run alongside the Task's step containers.

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

Method Summary

Modifier and Type	Method and Description
Sidecar	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 Sidecar.
Probe	getReadinessProbe() Optional.
String	getScript() The contents of an executable file to execute.
SecurityContext	getSecurityContext() Optional.
List<VolumeMount>	getVolumeMounts() Pod volumes to mount into the container's filesystem.
String	getWorkingDir() Container's working directory.
Sidecar	set(String fieldName, Object value)
Sidecar	setArgs(List<String> args) Arguments to the entrypoint.
Sidecar	setCommand(List<String> command) Entrypoint array.
Sidecar	setEnv(List<EnvVar> env) List of environment variables to set in the container.
Sidecar	setImage(String image) Docker image name.
Sidecar	setName(String name) Name of the Sidecar.
Sidecar	setReadinessProbe(Probe readinessProbe) Optional.
Sidecar	setScript(String script) The contents of an executable file to execute.
Sidecar	setSecurityContext(SecurityContext securityContext) Optional.
Sidecar	setVolumeMounts(List<VolumeMount> volumeMounts) Pod volumes to mount into the container's filesystem.
Sidecar	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

Sidecar

public Sidecar()

Method Detail

getArgs

public List<String> getArgs()

Arguments to the entrypoint.

Returns:

value or null for none

setArgs

public Sidecar 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 Sidecar 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 Sidecar 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 Sidecar setImage(String image)

Docker image name.

Parameters:

image - image or null for none

getName

public String getName()

Name of the Sidecar.

Returns:

value or null for none

setName

public Sidecar setName(String name)

Name of the Sidecar.

Parameters:

name - name or null for none

getReadinessProbe

public Probe getReadinessProbe()

Optional. Periodic probe of Sidecar service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional

Returns:

value or null for none

setReadinessProbe

public Sidecar setReadinessProbe(Probe readinessProbe)

Optional. Periodic probe of Sidecar service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional

Parameters:

readinessProbe - readinessProbe or null for none

getScript

public String getScript()

The contents of an executable file to execute.

Returns:

value or null for none

setScript

public Sidecar setScript(String script)

The contents of an executable file to execute.

Parameters:

script - script or null for none

getSecurityContext

public SecurityContext getSecurityContext()

Optional. Security options the container should be run with.

Returns:

value or null for none

setSecurityContext

public Sidecar setSecurityContext(SecurityContext securityContext)

Optional. Security options the container should be run with.

Parameters:

securityContext - securityContext 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 Sidecar 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 Sidecar setWorkingDir(String workingDir)

Container's working directory.

Parameters:

workingDir - workingDir or null for none

set

public Sidecar set(String fieldName,
                   Object value)

Overrides:

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

clone

public Sidecar clone()

Overrides:

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