Apigee API . organizations . environments . apis . revisions . deployments

Instance Methods

close()

Close httplib2 connections.

generateDeployChangeReport(name, override=None, x__xgafv=None)

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}/revisions/{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}`

generateUndeployChangeReport(name, x__xgafv=None)

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}`

Method Details

close()
Close httplib2 connections.
generateDeployChangeReport(name, override=None, x__xgafv=None)
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}/revisions/{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}`

Args:
  name: string, Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` (required)
  override: boolean, Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. This report contains any validation failures that would cause the deployment to be rejected, as well changes and conflicts in routing that may occur due to the new deployment. The existence of a routing warning does not necessarily imply that the deployment request is bad, if the desired state of the deployment request is to effect a routing change. The primary purposes of the routing messages are: 1) To inform users of routing changes that may have an effect on traffic currently being routed to other existing deployments. 2) To warn users if some basepath in the proxy will not receive traffic due to an existing deployment having already claimed that basepath. The presence of routing conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected.
  "routingChanges": [ # All routing changes that may result from a deployment request.
    { # Describes a potential routing change that may occur as a result of some deployment operation.
      "description": "A String", # A human-readable description of this routing change.
      "environmentGroup": "A String", # The name of the environment group affected by this routing change.
      "fromDeployment": { # A tuple representing a basepath and the deployment containing it. # The basepath/deployment that may stop receiving some traffic.
        "apiProxy": "A String", # The name of the deployed proxy revision containing the basepath.
        "basepath": "A String", # The basepath receiving traffic.
        "environment": "A String", # The name of the environment in which the proxy is deployed.
        "revision": "A String", # The name of the deployed proxy revision containing the basepath.
      },
      "shouldSequenceRollout": True or False, # True if using sequenced rollout would make this routing change safer. Note: this does not necessarily imply that automated sequenced rollout mode is supported for the operation.
      "toDeployment": { # A tuple representing a basepath and the deployment containing it. # The basepath/deployment that may start receiving that traffic. May be null if no deployment is able to receive the traffic.
        "apiProxy": "A String", # The name of the deployed proxy revision containing the basepath.
        "basepath": "A String", # The basepath receiving traffic.
        "environment": "A String", # The name of the environment in which the proxy is deployed.
        "revision": "A String", # The name of the deployed proxy revision containing the basepath.
      },
    },
  ],
  "routingConflicts": [ # All basepath conflicts detected for a deployment request.
    { # Describes a routing conflict that may cause a deployment not to receive traffic at some basepath.
      "conflictingDeployment": { # A tuple representing a basepath and the deployment containing it. # The existing basepath/deployment causing the conflict.
        "apiProxy": "A String", # The name of the deployed proxy revision containing the basepath.
        "basepath": "A String", # The basepath receiving traffic.
        "environment": "A String", # The name of the environment in which the proxy is deployed.
        "revision": "A String", # The name of the deployed proxy revision containing the basepath.
      },
      "description": "A String", # A human-readable description of this conflict.
      "environmentGroup": "A String", # The name of the environment group in which this conflict exists.
    },
  ],
  "validationErrors": { # Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message. # Validation errors that would cause the deployment change request to be rejected.
    "violations": [ # Describes all precondition violations.
      { # A message type used to describe a single precondition failure.
        "description": "A String", # A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: "Terms of service not accepted".
        "subject": "A String", # The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.
        "type": "A String", # The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".
      },
    ],
  },
}
generateUndeployChangeReport(name, x__xgafv=None)
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}`

Args:
  name: string, Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. This report contains any validation failures that would cause the deployment to be rejected, as well changes and conflicts in routing that may occur due to the new deployment. The existence of a routing warning does not necessarily imply that the deployment request is bad, if the desired state of the deployment request is to effect a routing change. The primary purposes of the routing messages are: 1) To inform users of routing changes that may have an effect on traffic currently being routed to other existing deployments. 2) To warn users if some basepath in the proxy will not receive traffic due to an existing deployment having already claimed that basepath. The presence of routing conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected.
  "routingChanges": [ # All routing changes that may result from a deployment request.
    { # Describes a potential routing change that may occur as a result of some deployment operation.
      "description": "A String", # A human-readable description of this routing change.
      "environmentGroup": "A String", # The name of the environment group affected by this routing change.
      "fromDeployment": { # A tuple representing a basepath and the deployment containing it. # The basepath/deployment that may stop receiving some traffic.
        "apiProxy": "A String", # The name of the deployed proxy revision containing the basepath.
        "basepath": "A String", # The basepath receiving traffic.
        "environment": "A String", # The name of the environment in which the proxy is deployed.
        "revision": "A String", # The name of the deployed proxy revision containing the basepath.
      },
      "shouldSequenceRollout": True or False, # True if using sequenced rollout would make this routing change safer. Note: this does not necessarily imply that automated sequenced rollout mode is supported for the operation.
      "toDeployment": { # A tuple representing a basepath and the deployment containing it. # The basepath/deployment that may start receiving that traffic. May be null if no deployment is able to receive the traffic.
        "apiProxy": "A String", # The name of the deployed proxy revision containing the basepath.
        "basepath": "A String", # The basepath receiving traffic.
        "environment": "A String", # The name of the environment in which the proxy is deployed.
        "revision": "A String", # The name of the deployed proxy revision containing the basepath.
      },
    },
  ],
  "routingConflicts": [ # All basepath conflicts detected for a deployment request.
    { # Describes a routing conflict that may cause a deployment not to receive traffic at some basepath.
      "conflictingDeployment": { # A tuple representing a basepath and the deployment containing it. # The existing basepath/deployment causing the conflict.
        "apiProxy": "A String", # The name of the deployed proxy revision containing the basepath.
        "basepath": "A String", # The basepath receiving traffic.
        "environment": "A String", # The name of the environment in which the proxy is deployed.
        "revision": "A String", # The name of the deployed proxy revision containing the basepath.
      },
      "description": "A String", # A human-readable description of this conflict.
      "environmentGroup": "A String", # The name of the environment group in which this conflict exists.
    },
  ],
  "validationErrors": { # Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message. # Validation errors that would cause the deployment change request to be rejected.
    "violations": [ # Describes all precondition violations.
      { # A message type used to describe a single precondition failure.
        "description": "A String", # A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: "Terms of service not accepted".
        "subject": "A String", # The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.
        "type": "A String", # The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".
      },
    ],
  },
}