com.google.api.services.deploymentmanager

Class DeploymentManagerV2Beta.Deployments.Patch

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.deploymentmanager.DeploymentManagerV2BetaRequest<Operation>

com.google.api.services.deploymentmanager.DeploymentManagerV2Beta.Deployments.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DeploymentManagerV2Beta.Deployments

public class DeploymentManagerV2Beta.Deployments.Patch
extends DeploymentManagerV2BetaRequest<Operation>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Patch(String project, String deployment, Deployment content) Patches a deployment and all of the resources described by the deployment manifest.

Method Summary

Modifier and Type	Method and Description
String	getCreatePolicy() Sets the policy to use for creating new resources.
String	getDeletePolicy() Sets the policy to use for deleting resources.
String	getDeployment() The name of the deployment for this request.
Boolean	getPreview() If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources.
String	getProject() The project ID for this request.
boolean	isPreview() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
DeploymentManagerV2Beta.Deployments.Patch	set(String parameterName, Object value)
DeploymentManagerV2Beta.Deployments.Patch	setAlt(String alt) Data format for the response.
DeploymentManagerV2Beta.Deployments.Patch	setCreatePolicy(String createPolicy) Sets the policy to use for creating new resources.
DeploymentManagerV2Beta.Deployments.Patch	setDeletePolicy(String deletePolicy) Sets the policy to use for deleting resources.
DeploymentManagerV2Beta.Deployments.Patch	setDeployment(String deployment) The name of the deployment for this request.
DeploymentManagerV2Beta.Deployments.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
DeploymentManagerV2Beta.Deployments.Patch	setKey(String key) API key.
DeploymentManagerV2Beta.Deployments.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DeploymentManagerV2Beta.Deployments.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DeploymentManagerV2Beta.Deployments.Patch	setPreview(Boolean preview) If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources.
DeploymentManagerV2Beta.Deployments.Patch	setProject(String project) The project ID for this request.
DeploymentManagerV2Beta.Deployments.Patch	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
DeploymentManagerV2Beta.Deployments.Patch	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.deploymentmanager.DeploymentManagerV2BetaRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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

Patch

protected Patch(String project,
                String deployment,
                Deployment content)

Patches a deployment and all of the resources described by the deployment manifest. Create a request for the method "deployments.patch". This request holds the parameters needed by the the deploymentmanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

DeploymentManagerV2Beta.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - The project ID for this request.

deployment - The name of the deployment for this request.

content - the Deployment

Since:

1.13

Method Detail

setAlt

public DeploymentManagerV2Beta.Deployments.Patch setAlt(String alt)

Description copied from class: DeploymentManagerV2BetaRequest

Data format for the response.

Overrides:

setAlt in class DeploymentManagerV2BetaRequest<Operation>

setFields

public DeploymentManagerV2Beta.Deployments.Patch setFields(String fields)

Description copied from class: DeploymentManagerV2BetaRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DeploymentManagerV2BetaRequest<Operation>

setKey

public DeploymentManagerV2Beta.Deployments.Patch setKey(String key)

Description copied from class: DeploymentManagerV2BetaRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DeploymentManagerV2BetaRequest<Operation>

setOauthToken

public DeploymentManagerV2Beta.Deployments.Patch setOauthToken(String oauthToken)

Description copied from class: DeploymentManagerV2BetaRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DeploymentManagerV2BetaRequest<Operation>

setPrettyPrint

public DeploymentManagerV2Beta.Deployments.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: DeploymentManagerV2BetaRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DeploymentManagerV2BetaRequest<Operation>

setQuotaUser

public DeploymentManagerV2Beta.Deployments.Patch setQuotaUser(String quotaUser)

Description copied from class: DeploymentManagerV2BetaRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class DeploymentManagerV2BetaRequest<Operation>

setUserIp

public DeploymentManagerV2Beta.Deployments.Patch setUserIp(String userIp)

Description copied from class: DeploymentManagerV2BetaRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DeploymentManagerV2BetaRequest<Operation>

getProject

public String getProject()

The project ID for this request.

setProject

public DeploymentManagerV2Beta.Deployments.Patch setProject(String project)

The project ID for this request.

getDeployment

public String getDeployment()

The name of the deployment for this request.

setDeployment

public DeploymentManagerV2Beta.Deployments.Patch setDeployment(String deployment)

The name of the deployment for this request.

getCreatePolicy

public String getCreatePolicy()

Sets the policy to use for creating new resources. [default: CREATE_OR_ACQUIRE]

setCreatePolicy

public DeploymentManagerV2Beta.Deployments.Patch setCreatePolicy(String createPolicy)

Sets the policy to use for creating new resources.

getDeletePolicy

public String getDeletePolicy()

Sets the policy to use for deleting resources. [default: DELETE]

setDeletePolicy

public DeploymentManagerV2Beta.Deployments.Patch setDeletePolicy(String deletePolicy)

Sets the policy to use for deleting resources.

getPreview

public Boolean getPreview()

If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a `target.config` with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the `update()` or you can `cancelPreview()` to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. [default: false]

setPreview

public DeploymentManagerV2Beta.Deployments.Patch setPreview(Boolean preview)

If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a `target.config` with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the `update()` or you can `cancelPreview()` to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

isPreview

public boolean isPreview()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a `target.config` with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the `update()` or you can `cancelPreview()` to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

set

public DeploymentManagerV2Beta.Deployments.Patch set(String parameterName,
                                                     Object value)

Overrides:

set in class DeploymentManagerV2BetaRequest<Operation>