com.google.api.services.apigee.v1

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Apigee.Organizations.Environments.Apis.Revisions.Deployments

public class Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport
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	GenerateDeployChangeReport(String name) Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment.

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}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently .
Boolean	getOverride() Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	set(String parameterName, Object value)
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	set$Xgafv(String $Xgafv) V1 error format.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setAccessToken(String accessToken) OAuth access token.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setAlt(String alt) Data format for response.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setCallback(String callback) JSONP
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setFields(String fields) Selector specifying which fields to include in a partial response.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setKey(String key) API key.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setName(String name) Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently .
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setOverride(Boolean override) Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport	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

GenerateDeployChangeReport

protected GenerateDeployChangeReport(String name)

Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api}/r evisions/{rev}/deployments:generateDeployChangeReport`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` Create a request for the method "deployments.generateDeployChangeReport". 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.

GenerateDeployChangeReport#initialize(com.google.api.client.googleapis.se rvices.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}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api- platform/system-administration/spaces/apigee-spaces-overview).

Since:

1.13

Method Detail

set$Xgafv

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport 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.GenerateDeployChangeReport 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.GenerateDeployChangeReport 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.GenerateDeployChangeReport setCallback(String callback)

Description copied from class: ApigeeRequest

JSONP

Overrides:

setCallback in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>

setFields

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport 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.GenerateDeployChangeReport 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.GenerateDeployChangeReport 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.GenerateDeployChangeReport 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.GenerateDeployChangeReport 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.GenerateDeployChangeReport 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.GenerateDeployChangeReport 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}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

setName

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

Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system- administration/spaces/apigee-spaces-overview).

getOverride

public Boolean getOverride()

Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.

setOverride

public Apigee.Organizations.Environments.Apis.Revisions.Deployments.GenerateDeployChangeReport setOverride(Boolean override)

Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.

set

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

Overrides:

set in class ApigeeRequest<GoogleCloudApigeeV1DeploymentChangeReport>