Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / apigee_v1.organizations.environments.sharedflows.revisions.html
blob: b51b512fe57236ee5c8d0ce789933f88885fad69 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#deploy">deploy(name, override=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.deploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}`</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#getDeployments">getDeployments(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]85<p class="firstline">Gets the deployment of a shared flow revision and actual state reported by runtime pods.</p>
86<p class="toc_element">
87 <code><a href="#undeploy">undeploy(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Undeploys a shared flow revision from an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.undeploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}`</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]93</div>
94
95<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]96 <code class="details" id="deploy">deploy(name, override=None, x__xgafv=None)</code>
97 <pre>Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.deploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98
99Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]100 name: string, Required. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` (required)
101 override: boolean, Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks. If an existing shared flow revision is deployed, to ensure seamless deployment with no downtime, set this parameter to `true`. In this case, hybrid deploys the new revision fully before undeploying the existing revision. If set to `false`, you must undeploy the existing revision before deploying the new revision.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107Returns:
108 An object of the form:
109
110 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111 &quot;environment&quot;: &quot;A String&quot;, # Environment.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]112 &quot;instances&quot;: [ # Status reported by each runtime instance. This field is not populated in List APIs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]113 { # The status of a deployment as reported by a single instance.
114 &quot;deployedRevisions&quot;: [ # Revisions currently deployed in MPs.
115 { # Revisions deployed in the MPs.
116 &quot;revision&quot;: &quot;A String&quot;, # The proxy revision reported as deployed.
117 &quot;percentage&quot;: 42, # The percentage of MP replicas reporting this revision
118 },
119 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]120 &quot;instance&quot;: &quot;A String&quot;, # ID of the instance reporting the status.
121 &quot;deployedRoutes&quot;: [ # The current routes deployed in the ingress routing table. A route which is missing will be shown with no destination environment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]122 { # A route deployed in the ingress routing table.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]123 &quot;environment&quot;: &quot;A String&quot;, # The destination environment. This will be empty if the route is not yet reported.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124 &quot;envgroup&quot;: &quot;A String&quot;, # The envgroup where this route is installed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]125 &quot;basepath&quot;: &quot;A String&quot;, # The basepath in the routing table.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 &quot;percentage&quot;: 42, # The percentage of ingress replicas reporting this route.
127 },
128 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]129 },
130 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]131 &quot;revision&quot;: &quot;A String&quot;, # API proxy revision.
132 &quot;pods&quot;: [ # Status reported by runtime pods. This field is not populated for List APIs.
133 {
134 &quot;statusCodeDetails&quot;: &quot;A String&quot;, # Human-readable message associated with the status code.
135 &quot;podStatus&quot;: &quot;A String&quot;, # Overall status of the pod (not this specific deployment). Valid values include: - `active`: Up to date. - `stale` : Recently out of date. Pods that have not reported status in a long time are excluded from the output.
136 &quot;deploymentTime&quot;: &quot;A String&quot;, # Time the proxy was deployed in milliseconds since epoch.
137 &quot;deploymentStatus&quot;: &quot;A String&quot;, # Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment.
138 &quot;podName&quot;: &quot;A String&quot;, # Name of the pod which is reporting the status.
139 &quot;appVersion&quot;: &quot;A String&quot;, # Version of the application running in the pod.
140 &quot;statusCode&quot;: &quot;A String&quot;, # Code associated with the deployment status.
141 &quot;podStatusTime&quot;: &quot;A String&quot;, # Time the pod status was reported in milliseconds since epoch.
142 &quot;deploymentStatusTime&quot;: &quot;A String&quot;, # Time the deployment status was reported in milliseconds since epoch.
143 },
144 ],
145 &quot;deployStartTime&quot;: &quot;A String&quot;, # Time the API proxy was marked `deployed` in the control plane in millisconds since epoch.
146 &quot;routeConflicts&quot;: [ # Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be ERROR, but it will mean that some of the deployments basepaths are not routed to its environment. If the conflicts change, the state will transition to PROGRESSING until the latest configuration is rolled out to all instances. This field is not populated in List APIs.
147 { # Describes a routing conflict that may cause a deployment not to receive traffic at some basepath.
148 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of this conflict.
149 &quot;conflictingDeployment&quot;: { # A tuple representing a basepath and the deployment containing it. # The existing basepath/deployment causing the conflict.
150 &quot;apiProxy&quot;: &quot;A String&quot;, # The name of the deployed proxy revision containing the basepath.
151 &quot;revision&quot;: &quot;A String&quot;, # The name of the deployed proxy revision containing the basepath.
152 &quot;environment&quot;: &quot;A String&quot;, # The name of the environment in which the proxy is deployed.
153 &quot;basepath&quot;: &quot;A String&quot;, # The basepath receiving traffic.
154 },
155 &quot;environmentGroup&quot;: &quot;A String&quot;, # The name of the environment group in which this conflict exists.
156 },
157 ],
158 &quot;errors&quot;: [ # Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs.
159 { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]160 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]161 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]162 {
163 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
164 },
165 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]166 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]167 },
168 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]169 &quot;state&quot;: &quot;A String&quot;, # Current state of the deployment. This field is not populated in List APIs.
170 &quot;apiProxy&quot;: &quot;A String&quot;, # API proxy.
171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="getDeployments">getDeployments(name, x__xgafv=None)</code>
176 <pre>Gets the deployment of a shared flow revision and actual state reported by runtime pods.
177
178Args:
179 name: string, Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` (required)
180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185Returns:
186 An object of the form:
187
188 {
189 &quot;environment&quot;: &quot;A String&quot;, # Environment.
190 &quot;instances&quot;: [ # Status reported by each runtime instance. This field is not populated in List APIs.
191 { # The status of a deployment as reported by a single instance.
192 &quot;deployedRevisions&quot;: [ # Revisions currently deployed in MPs.
193 { # Revisions deployed in the MPs.
194 &quot;revision&quot;: &quot;A String&quot;, # The proxy revision reported as deployed.
195 &quot;percentage&quot;: 42, # The percentage of MP replicas reporting this revision
196 },
197 ],
198 &quot;instance&quot;: &quot;A String&quot;, # ID of the instance reporting the status.
199 &quot;deployedRoutes&quot;: [ # The current routes deployed in the ingress routing table. A route which is missing will be shown with no destination environment.
200 { # A route deployed in the ingress routing table.
201 &quot;environment&quot;: &quot;A String&quot;, # The destination environment. This will be empty if the route is not yet reported.
202 &quot;envgroup&quot;: &quot;A String&quot;, # The envgroup where this route is installed.
203 &quot;basepath&quot;: &quot;A String&quot;, # The basepath in the routing table.
204 &quot;percentage&quot;: 42, # The percentage of ingress replicas reporting this route.
205 },
206 ],
207 },
208 ],
209 &quot;revision&quot;: &quot;A String&quot;, # API proxy revision.
210 &quot;pods&quot;: [ # Status reported by runtime pods. This field is not populated for List APIs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]212 &quot;statusCodeDetails&quot;: &quot;A String&quot;, # Human-readable message associated with the status code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]213 &quot;podStatus&quot;: &quot;A String&quot;, # Overall status of the pod (not this specific deployment). Valid values include: - `active`: Up to date. - `stale` : Recently out of date. Pods that have not reported status in a long time are excluded from the output.
214 &quot;deploymentTime&quot;: &quot;A String&quot;, # Time the proxy was deployed in milliseconds since epoch.
215 &quot;deploymentStatus&quot;: &quot;A String&quot;, # Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]216 &quot;podName&quot;: &quot;A String&quot;, # Name of the pod which is reporting the status.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]217 &quot;appVersion&quot;: &quot;A String&quot;, # Version of the application running in the pod.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]218 &quot;statusCode&quot;: &quot;A String&quot;, # Code associated with the deployment status.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]219 &quot;podStatusTime&quot;: &quot;A String&quot;, # Time the pod status was reported in milliseconds since epoch.
220 &quot;deploymentStatusTime&quot;: &quot;A String&quot;, # Time the deployment status was reported in milliseconds since epoch.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 },
222 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]223 &quot;deployStartTime&quot;: &quot;A String&quot;, # Time the API proxy was marked `deployed` in the control plane in millisconds since epoch.
224 &quot;routeConflicts&quot;: [ # Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be ERROR, but it will mean that some of the deployments basepaths are not routed to its environment. If the conflicts change, the state will transition to PROGRESSING until the latest configuration is rolled out to all instances. This field is not populated in List APIs.
225 { # Describes a routing conflict that may cause a deployment not to receive traffic at some basepath.
226 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of this conflict.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]227 &quot;conflictingDeployment&quot;: { # A tuple representing a basepath and the deployment containing it. # The existing basepath/deployment causing the conflict.
228 &quot;apiProxy&quot;: &quot;A String&quot;, # The name of the deployed proxy revision containing the basepath.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]229 &quot;revision&quot;: &quot;A String&quot;, # The name of the deployed proxy revision containing the basepath.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]230 &quot;environment&quot;: &quot;A String&quot;, # The name of the environment in which the proxy is deployed.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]231 &quot;basepath&quot;: &quot;A String&quot;, # The basepath receiving traffic.
232 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]233 &quot;environmentGroup&quot;: &quot;A String&quot;, # The name of the environment group in which this conflict exists.
234 },
235 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]236 &quot;errors&quot;: [ # Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs.
237 { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
238 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
239 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
240 {
241 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
242 },
243 ],
244 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
245 },
246 ],
247 &quot;state&quot;: &quot;A String&quot;, # Current state of the deployment. This field is not populated in List APIs.
248 &quot;apiProxy&quot;: &quot;A String&quot;, # API proxy.
249 }</pre>
250</div>
251
252<div class="method">
253 <code class="details" id="undeploy">undeploy(name, x__xgafv=None)</code>
254 <pre>Undeploys a shared flow revision from an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.undeploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}`
255
256Args:
257 name: string, Required. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` (required)
258 x__xgafv: string, V1 error format.
259 Allowed values
260 1 - v1 error format
261 2 - v2 error format
262
263Returns:
264 An object of the form:
265
266 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]267 }</pre>
268</div>
269
270</body></html>