| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <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.sharedflows.html">sharedflows</a> . <a href="apigee_v1.organizations.environments.sharedflows.revisions.html">revisions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#deployments">deployments(name, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Undeploys a shared flow revision from an environment.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#getDeployments">getDeployments(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Gets the deployment of a shared flow revision and actual state reported by</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| 85 | <code class="details" id="deployments">deployments(name, x__xgafv=None)</code> |
| 86 | <pre>Undeploys a shared flow revision from an environment. |
| 87 | |
| 88 | Args: |
| 89 | name: string, Required. Name of the shared flow revision to undeploy in the following format: |
| 90 | `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` (required) |
| 91 | x__xgafv: string, V1 error format. |
| 92 | Allowed values |
| 93 | 1 - v1 error format |
| 94 | 2 - v2 error format |
| 95 | |
| 96 | Returns: |
| 97 | An object of the form: |
| 98 | |
| 99 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 100 | # empty messages in your APIs. A typical example is to use it as the request |
| 101 | # or the response type of an API method. For instance: |
| 102 | # |
| 103 | # service Foo { |
| 104 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 105 | # } |
| 106 | # |
| 107 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 108 | }</pre> |
| 109 | </div> |
| 110 | |
| 111 | <div class="method"> |
| 112 | <code class="details" id="getDeployments">getDeployments(name, x__xgafv=None)</code> |
| 113 | <pre>Gets the deployment of a shared flow revision and actual state reported by |
| 114 | runtime pods. |
| 115 | |
| 116 | Args: |
| 117 | name: string, Required. Name representing a shared flow in an environment in the following |
| 118 | format: |
| 119 | `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` (required) |
| 120 | x__xgafv: string, V1 error format. |
| 121 | Allowed values |
| 122 | 1 - v1 error format |
| 123 | 2 - v2 error format |
| 124 | |
| 125 | Returns: |
| 126 | An object of the form: |
| 127 | |
| 128 | { |
| 129 | "pods": [ # Status reported by runtime pods. |
| 130 | { |
| 131 | "deploymentStatus": "A String", # Status of the deployment. Valid values |
| 132 | # include: |
| 133 | # - `deployed`: Successful. |
| 134 | # - `error` : Failed. |
| 135 | # - `pending` : Pod has not yet reported on the deployment. |
| 136 | "podStatusTime": "A String", # Time the pod status was reported in milliseconds since epoch. |
| 137 | "statusCodeDetails": "A String", # Human-readable message associated with the status code. |
| 138 | "deploymentTime": "A String", # Time the proxy was deployed in milliseconds since epoch. |
| 139 | "statusCode": "A String", # Code associated with the deployment status. |
| 140 | "podStatus": "A String", # Overall status of the pod (not this specific deployment). Valid values |
| 141 | # include: |
| 142 | # - `active`: Up to date. |
| 143 | # - `stale` : Recently out of date. |
| 144 | # |
| 145 | # Pods that have not reported status in a |
| 146 | # long time are excluded from the output. |
| 147 | "podName": "A String", # Name of the pod which is reporting the status. |
| 148 | "appVersion": "A String", # Version of the application running in the pod. |
| 149 | "deploymentStatusTime": "A String", # Time the deployment status was reported in milliseconds since epoch. |
| 150 | }, |
| 151 | ], |
| 152 | "environment": "A String", # Environment. |
| 153 | "basePath": "A String", # Base path for the deployment. |
| 154 | "deployStartTime": "A String", # Time the API proxy was marked `deployed` in the control plane in |
| 155 | # millisconds since epoch. |
| 156 | "apiProxy": "A String", # API proxy. |
| 157 | "revision": "A String", # API proxy revision. |
| 158 | }</pre> |
| 159 | </div> |
| 160 | |
| 161 | </body></html> |