| 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"> |
| Dmitry Frenkel | 3e17f89 | 2020-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"> |
| yoshi-code-bot | 4c9ccb0 | 2021-05-27 00:38:02 -0700 | [diff] [blame^] | 81 | <code><a href="#deploy">deploy(name, override=None, serviceAccount=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 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 Kim | 6502091 | 2020-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 Frenkel | 3e17f89 | 2020-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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| yoshi-code-bot | 4c9ccb0 | 2021-05-27 00:38:02 -0700 | [diff] [blame^] | 96 | <code class="details" id="deploy">deploy(name, override=None, serviceAccount=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 98 | |
| 99 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-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) |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 101 | override: boolean, Flag that specifies whether the new deployment replaces other deployed revisions of the shared flow in the environment. Set `override` to `true` to replace other deployed revisions. By default, `override` is `false` and the deployment is rejected if other revisions of the shared flow are deployed in the environment. |
| yoshi-code-bot | 4c9ccb0 | 2021-05-27 00:38:02 -0700 | [diff] [blame^] | 102 | serviceAccount: string, Google Cloud IAM service account. The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be `{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | x__xgafv: string, V1 error format. |
| 104 | Allowed values |
| 105 | 1 - v1 error format |
| 106 | 2 - v2 error format |
| 107 | |
| 108 | Returns: |
| 109 | An object of the form: |
| 110 | |
| 111 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 112 | "apiProxy": "A String", # API proxy. |
| 113 | "deployStartTime": "A String", # Time the API proxy was marked `deployed` in the control plane in millisconds since epoch. |
| 114 | "environment": "A String", # Environment. |
| 115 | "errors": [ # Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs. |
| 116 | { # 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). |
| 117 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 118 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 119 | { |
| 120 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 121 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 122 | ], |
| 123 | "message": "A String", # 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. |
| 124 | }, |
| 125 | ], |
| 126 | "instances": [ # Status reported by each runtime instance. This field is not populated in List APIs. |
| 127 | { # The status of a deployment as reported by a single instance. |
| 128 | "deployedRevisions": [ # Revisions currently deployed in MPs. |
| 129 | { # Revisions deployed in the MPs. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 130 | "percentage": 42, # Percentage of MP replicas reporting this revision. |
| 131 | "revision": "A String", # API proxy revision reported as deployed. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 132 | }, |
| 133 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 134 | "deployedRoutes": [ # Current routes deployed in the ingress routing table. A route which is missing will appear in `missing_routes`. |
| 135 | { # Route deployed in the ingress routing table. |
| 136 | "basepath": "A String", # Base path in the routing table. |
| 137 | "envgroup": "A String", # Environment group where this route is installed. |
| 138 | "environment": "A String", # Destination environment. This will be empty if the route is not yet reported. |
| 139 | "percentage": 42, # Percentage of ingress replicas reporting this route. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 140 | }, |
| 141 | ], |
| 142 | "instance": "A String", # ID of the instance reporting the status. |
| 143 | }, |
| 144 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 145 | "pods": [ # Status reported by runtime pods. This field is not populated for List APIs. **Note**: **This field is deprecated**. Runtime versions 1.3 and above report instance level status rather than pod status. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 146 | { |
| 147 | "appVersion": "A String", # Version of the application running in the pod. |
| 148 | "deploymentStatus": "A String", # Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment. |
| 149 | "deploymentStatusTime": "A String", # Time the deployment status was reported in milliseconds since epoch. |
| 150 | "deploymentTime": "A String", # Time the proxy was deployed in milliseconds since epoch. |
| 151 | "podName": "A String", # Name of the pod which is reporting the status. |
| 152 | "podStatus": "A String", # 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. |
| 153 | "podStatusTime": "A String", # Time the pod status was reported in milliseconds since epoch. |
| 154 | "statusCode": "A String", # Code associated with the deployment status. |
| 155 | "statusCodeDetails": "A String", # Human-readable message associated with the status code. |
| 156 | }, |
| 157 | ], |
| 158 | "revision": "A String", # API proxy revision. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 159 | "routeConflicts": [ # 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 deployment's base paths 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. |
| 160 | { # Describes a routing conflict that may cause a deployment not to receive traffic at some base path. |
| 161 | "conflictingDeployment": { # Tuple representing a base path and the deployment containing it. # Existing base path/deployment causing the conflict. |
| 162 | "apiProxy": "A String", # Name of the deployed API proxy revision containing the base path. |
| 163 | "basepath": "A String", # Base path receiving traffic. |
| 164 | "environment": "A String", # Name of the environment in which the proxy is deployed. |
| 165 | "revision": "A String", # Name of the deployed API proxy revision containing the base path. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 166 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 167 | "description": "A String", # Human-readable description of this conflict. |
| 168 | "environmentGroup": "A String", # Name of the environment group in which this conflict exists. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 169 | }, |
| 170 | ], |
| yoshi-code-bot | 4c9ccb0 | 2021-05-27 00:38:02 -0700 | [diff] [blame^] | 171 | "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 172 | "state": "A String", # Current state of the deployment. This field is not populated in List APIs. |
| 173 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 174 | </div> |
| 175 | |
| 176 | <div class="method"> |
| 177 | <code class="details" id="getDeployments">getDeployments(name, x__xgafv=None)</code> |
| 178 | <pre>Gets the deployment of a shared flow revision and actual state reported by runtime pods. |
| 179 | |
| 180 | Args: |
| 181 | name: string, Required. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` (required) |
| 182 | x__xgafv: string, V1 error format. |
| 183 | Allowed values |
| 184 | 1 - v1 error format |
| 185 | 2 - v2 error format |
| 186 | |
| 187 | Returns: |
| 188 | An object of the form: |
| 189 | |
| 190 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 191 | "apiProxy": "A String", # API proxy. |
| 192 | "deployStartTime": "A String", # Time the API proxy was marked `deployed` in the control plane in millisconds since epoch. |
| 193 | "environment": "A String", # Environment. |
| 194 | "errors": [ # Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs. |
| 195 | { # 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). |
| 196 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 197 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 198 | { |
| 199 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 200 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 201 | ], |
| 202 | "message": "A String", # 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. |
| 203 | }, |
| 204 | ], |
| 205 | "instances": [ # Status reported by each runtime instance. This field is not populated in List APIs. |
| 206 | { # The status of a deployment as reported by a single instance. |
| 207 | "deployedRevisions": [ # Revisions currently deployed in MPs. |
| 208 | { # Revisions deployed in the MPs. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 209 | "percentage": 42, # Percentage of MP replicas reporting this revision. |
| 210 | "revision": "A String", # API proxy revision reported as deployed. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 211 | }, |
| 212 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 213 | "deployedRoutes": [ # Current routes deployed in the ingress routing table. A route which is missing will appear in `missing_routes`. |
| 214 | { # Route deployed in the ingress routing table. |
| 215 | "basepath": "A String", # Base path in the routing table. |
| 216 | "envgroup": "A String", # Environment group where this route is installed. |
| 217 | "environment": "A String", # Destination environment. This will be empty if the route is not yet reported. |
| 218 | "percentage": 42, # Percentage of ingress replicas reporting this route. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 219 | }, |
| 220 | ], |
| 221 | "instance": "A String", # ID of the instance reporting the status. |
| 222 | }, |
| 223 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 224 | "pods": [ # Status reported by runtime pods. This field is not populated for List APIs. **Note**: **This field is deprecated**. Runtime versions 1.3 and above report instance level status rather than pod status. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 225 | { |
| 226 | "appVersion": "A String", # Version of the application running in the pod. |
| 227 | "deploymentStatus": "A String", # Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment. |
| 228 | "deploymentStatusTime": "A String", # Time the deployment status was reported in milliseconds since epoch. |
| 229 | "deploymentTime": "A String", # Time the proxy was deployed in milliseconds since epoch. |
| 230 | "podName": "A String", # Name of the pod which is reporting the status. |
| 231 | "podStatus": "A String", # 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. |
| 232 | "podStatusTime": "A String", # Time the pod status was reported in milliseconds since epoch. |
| 233 | "statusCode": "A String", # Code associated with the deployment status. |
| 234 | "statusCodeDetails": "A String", # Human-readable message associated with the status code. |
| 235 | }, |
| 236 | ], |
| 237 | "revision": "A String", # API proxy revision. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 238 | "routeConflicts": [ # 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 deployment's base paths 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. |
| 239 | { # Describes a routing conflict that may cause a deployment not to receive traffic at some base path. |
| 240 | "conflictingDeployment": { # Tuple representing a base path and the deployment containing it. # Existing base path/deployment causing the conflict. |
| 241 | "apiProxy": "A String", # Name of the deployed API proxy revision containing the base path. |
| 242 | "basepath": "A String", # Base path receiving traffic. |
| 243 | "environment": "A String", # Name of the environment in which the proxy is deployed. |
| 244 | "revision": "A String", # Name of the deployed API proxy revision containing the base path. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 245 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 246 | "description": "A String", # Human-readable description of this conflict. |
| 247 | "environmentGroup": "A String", # Name of the environment group in which this conflict exists. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 248 | }, |
| 249 | ], |
| yoshi-code-bot | 4c9ccb0 | 2021-05-27 00:38:02 -0700 | [diff] [blame^] | 250 | "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 251 | "state": "A String", # Current state of the deployment. This field is not populated in List APIs. |
| 252 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 253 | </div> |
| 254 | |
| 255 | <div class="method"> |
| 256 | <code class="details" id="undeploy">undeploy(name, x__xgafv=None)</code> |
| 257 | <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}` |
| 258 | |
| 259 | Args: |
| 260 | name: string, Required. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` (required) |
| 261 | x__xgafv: string, V1 error format. |
| 262 | Allowed values |
| 263 | 1 - v1 error format |
| 264 | 2 - v2 error format |
| 265 | |
| 266 | Returns: |
| 267 | An object of the form: |
| 268 | |
| 269 | { # 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 `{}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 270 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 271 | </div> |
| 272 | |
| 273 | </body></html> |