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

Class PipelineWorkspaceDeclaration

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

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

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

Method Summary

Modifier and Type	Method and Description
PipelineWorkspaceDeclaration	clone()
String	getDescription() Description is a human readable string describing how the workspace will be used in the Pipeline.
String	getName() Name is the name of a workspace to be provided by a PipelineRun.
Boolean	getOptional() Optional marks a Workspace as not being required in PipelineRuns.
PipelineWorkspaceDeclaration	set(String fieldName, Object value)
PipelineWorkspaceDeclaration	setDescription(String description) Description is a human readable string describing how the workspace will be used in the Pipeline.
PipelineWorkspaceDeclaration	setName(String name) Name is the name of a workspace to be provided by a PipelineRun.
PipelineWorkspaceDeclaration	setOptional(Boolean optional) Optional marks a Workspace as not being required in PipelineRuns.

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

PipelineWorkspaceDeclaration

public PipelineWorkspaceDeclaration()

Method Detail

getDescription

public String getDescription()

Description is a human readable string describing how the workspace will be used in the Pipeline.

Returns:

value or null for none

setDescription

public PipelineWorkspaceDeclaration setDescription(String description)

Description is a human readable string describing how the workspace will be used in the Pipeline.

Parameters:

description - description or null for none

getName

public String getName()

Name is the name of a workspace to be provided by a PipelineRun.

Returns:

value or null for none

setName

public PipelineWorkspaceDeclaration setName(String name)

Name is the name of a workspace to be provided by a PipelineRun.

Parameters:

name - name or null for none

getOptional

public Boolean getOptional()

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

Returns:

value or null for none

setOptional

public PipelineWorkspaceDeclaration setOptional(Boolean optional)

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

Parameters:

optional - optional or null for none

set

public PipelineWorkspaceDeclaration set(String fieldName,
                                        Object value)

Overrides:

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

clone

public PipelineWorkspaceDeclaration clone()

Overrides:

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