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

Class WorkspaceDeclaration

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

WorkspaceDeclaration is a declaration of a volume that a Task requires.

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

Method Summary

Modifier and Type	Method and Description
WorkspaceDeclaration	clone()
String	getDescription() Description is a human readable description of this volume.
String	getMountPath() MountPath overrides the directory that the volume will be made available at.
String	getName() Name is the name by which you can bind the volume at runtime.
Boolean	getOptional() Optional.
Boolean	getReadOnly() ReadOnly dictates whether a mounted volume is writable.
WorkspaceDeclaration	set(String fieldName, Object value)
WorkspaceDeclaration	setDescription(String description) Description is a human readable description of this volume.
WorkspaceDeclaration	setMountPath(String mountPath) MountPath overrides the directory that the volume will be made available at.
WorkspaceDeclaration	setName(String name) Name is the name by which you can bind the volume at runtime.
WorkspaceDeclaration	setOptional(Boolean optional) Optional.
WorkspaceDeclaration	setReadOnly(Boolean readOnly) ReadOnly dictates whether a mounted volume is writable.

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

WorkspaceDeclaration

public WorkspaceDeclaration()

Method Detail

getDescription

public String getDescription()

Description is a human readable description of this volume.

Returns:

value or null for none

setDescription

public WorkspaceDeclaration setDescription(String description)

Description is a human readable description of this volume.

Parameters:

description - description or null for none

getMountPath

public String getMountPath()

MountPath overrides the directory that the volume will be made available at.

Returns:

value or null for none

setMountPath

public WorkspaceDeclaration setMountPath(String mountPath)

MountPath overrides the directory that the volume will be made available at.

Parameters:

mountPath - mountPath or null for none

getName

public String getName()

Name is the name by which you can bind the volume at runtime.

Returns:

value or null for none

setName

public WorkspaceDeclaration setName(String name)

Name is the name by which you can bind the volume at runtime.

Parameters:

name - name or null for none

getOptional

public Boolean getOptional()

Optional. Optional marks a Workspace as not being required in TaskRuns. By default this field is false and so declared workspaces are required.

Returns:

value or null for none

setOptional

public WorkspaceDeclaration setOptional(Boolean optional)

Optional. Optional marks a Workspace as not being required in TaskRuns. By default this field is false and so declared workspaces are required.

Parameters:

optional - optional or null for none

getReadOnly

public Boolean getReadOnly()

ReadOnly dictates whether a mounted volume is writable.

Returns:

value or null for none

setReadOnly

public WorkspaceDeclaration setReadOnly(Boolean readOnly)

ReadOnly dictates whether a mounted volume is writable.

Parameters:

readOnly - readOnly or null for none

set

public WorkspaceDeclaration set(String fieldName,
                                Object value)

Overrides:

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

clone

public WorkspaceDeclaration clone()

Overrides:

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