| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.apis.html">apis</a> . <a href="apigee_v1.organizations.environments.apis.revisions.html">revisions</a> . <a href="apigee_v1.organizations.environments.apis.revisions.deployments.html">deployments</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#generateDeployChangeReport">generateDeployChangeReport(name, basepath=None, override=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Generates a report for a dry run analysis of a DeployApiProxy request</p> |
| <p class="toc_element"> |
| <code><a href="#generateUndeployChangeReport">generateUndeployChangeReport(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Generates a report for a dry run analysis of an UndeployApiProxy request</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="generateDeployChangeReport">generateDeployChangeReport(name, basepath=None, override=None, x__xgafv=None)</code> |
| <pre>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. |
| |
| Args: |
| name: string, Name of the API proxy revision deployment in the following format: |
| `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` (required) |
| basepath: string, Base path where the API proxy revision should be deployed. Defaults to '/' |
| if not provided. |
| 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. |
| "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. |
| "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. |
| "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. |
| "basepath": "A String", # The basepath receiving traffic. |
| }, |
| "environmentGroup": "A String", # The name of the environment group affected by this routing change. |
| "description": "A String", # A human-readable description of this routing change. |
| "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. |
| "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. |
| "basepath": "A String", # The basepath receiving traffic. |
| }, |
| }, |
| ], |
| "validationErrors": { # Describes what preconditions have failed. # Validation errors that would cause the deployment change request to be |
| # rejected. |
| # |
| # 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. |
| "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". |
| "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". |
| "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. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "basepath": "A String", # The basepath receiving traffic. |
| }, |
| "description": "A String", # A human-readable description of this conflict. |
| "environmentGroup": "A String", # The name of the environment group in which this conflict exists. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="generateUndeployChangeReport">generateUndeployChangeReport(name, x__xgafv=None)</code> |
| <pre>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. |
| |
| 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. |
| "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. |
| "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. |
| "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. |
| "basepath": "A String", # The basepath receiving traffic. |
| }, |
| "environmentGroup": "A String", # The name of the environment group affected by this routing change. |
| "description": "A String", # A human-readable description of this routing change. |
| "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. |
| "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. |
| "basepath": "A String", # The basepath receiving traffic. |
| }, |
| }, |
| ], |
| "validationErrors": { # Describes what preconditions have failed. # Validation errors that would cause the deployment change request to be |
| # rejected. |
| # |
| # 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. |
| "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". |
| "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". |
| "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. |
| }, |
| ], |
| }, |
| "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. |
| "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. |
| "basepath": "A String", # The basepath receiving traffic. |
| }, |
| "description": "A String", # A human-readable description of this conflict. |
| "environmentGroup": "A String", # The name of the environment group in which this conflict exists. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
