com.google.api.services.apigee.v1

Class Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport

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.apigee.v1.ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

com.google.api.services.apigee.v1.Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Apigee.Organizations.Environments.Apis.Revisions.Deployments

public class Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport
extends ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

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>

Field Summary

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenerateUndeployChangeReport(String name) Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy.

Method Summary

Modifier and Type	Method and Description
String	getName() Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	set(String parameterName, Object value)
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	set$Xgafv(String $Xgafv) V1 error format.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setAccessToken(String accessToken) OAuth access token.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setAlt(String alt) Data format for response.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setCallback(String callback) JSONP
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setFields(String fields) Selector specifying which fields to include in a partial response.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setKey(String key) API key.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setName(String name) Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.apigee.v1.ApigeeRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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

GenerateUndeployChangeReport

protected GenerateUndeployChangeReport(String name)

Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api} /revisions/{rev}/deployments:generateUndeployChangeReport`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.undeploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` Create a request for the method "deployments.generateUndeployChangeReport". This request holds the parameters needed by the the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

name - Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`

Since:

1.13

Method Detail

set$Xgafv

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport set$Xgafv(String $Xgafv)

Description copied from class: ApigeeRequest

V1 error format.

Overrides:

set$Xgafv in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setAccessToken

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setAccessToken(String accessToken)

Description copied from class: ApigeeRequest

OAuth access token.

Overrides:

setAccessToken in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setAlt

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setAlt(String alt)

Description copied from class: ApigeeRequest

Data format for response.

Overrides:

setAlt in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setCallback

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setCallback(String callback)

Description copied from class: ApigeeRequest

JSONP

Overrides:

setCallback in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setFields

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setFields(String fields)

Description copied from class: ApigeeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setKey

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setKey(String key)

Description copied from class: ApigeeRequest

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 ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setOauthToken

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setOauthToken(String oauthToken)

Description copied from class: ApigeeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setPrettyPrint

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setPrettyPrint(Boolean prettyPrint)

Description copied from class: ApigeeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setQuotaUser

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setQuotaUser(String quotaUser)

Description copied from class: ApigeeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setUploadType

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setUploadType(String uploadType)

Description copied from class: ApigeeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setUploadProtocol

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setUploadProtocol(String uploadProtocol)

Description copied from class: ApigeeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

getName

public String getName()

Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`

setName

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport setName(String name)

Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`

set

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateUndeployChangeReport set(String parameterName,
                                                                                                     Object value)

Overrides:

set in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>