Blame - docs/dyn/apigee_v1.organizations.environments.sharedflows.revisions.html - platform/external/python/google-api-python-client

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

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 Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

83

84

<code><a href="#getDeployments">getDeployments(name, x__xgafv=None)</a></code></p>

Dmitry Frenkel

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

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

2020-05-20 12:08:20 -0700

[diff] [blame]

89

<h3>Method Details</h3>

90

Dmitry Frenkel

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

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-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 Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

98

99

Args:

Dmitry Frenkel

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)

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 Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

102

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

109

110

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

111

"apiProxy": "A String", # API proxy.

112

"deployStartTime": "A String", # Time the API proxy was marked `deployed` in the control plane in millisconds since epoch.

113

"environment": "A String", # Environment.

114

"errors": [ # Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs.

115

{ # 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).

116

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

117

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

118

{

119

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

120

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

121

],

122

"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.

123

},

124

],

125

"instances": [ # Status reported by each runtime instance. This field is not populated in List APIs.

126

{ # The status of a deployment as reported by a single instance.

127

"deployedRevisions": [ # Revisions currently deployed in MPs.

128

{ # Revisions deployed in the MPs.

129

"percentage": 42, # The percentage of MP replicas reporting this revision

130

"revision": "A String", # The proxy revision reported as deployed.

131

},

132

],

133

"deployedRoutes": [ # The current routes deployed in the ingress routing table. A route which is missing will appear in missing_routes.

134

{ # A route deployed in the ingress routing table.

135

"basepath": "A String", # The basepath in the routing table.

136

"envgroup": "A String", # The envgroup where this route is installed.

137

"environment": "A String", # The destination environment. This will be empty if the route is not yet reported.

138

"percentage": 42, # The percentage of ingress replicas reporting this route.

139

},

140

],

141

"instance": "A String", # ID of the instance reporting the status.

142

},

143

],

144

"pods": [ # Status reported by runtime pods. This field is not populated for List APIs.

145

{

146

"appVersion": "A String", # Version of the application running in the pod.

147

"deploymentStatus": "A String", # Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment.

148

"deploymentStatusTime": "A String", # Time the deployment status was reported in milliseconds since epoch.

149

"deploymentTime": "A String", # Time the proxy was deployed in milliseconds since epoch.

150

"podName": "A String", # Name of the pod which is reporting the status.

151

"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.

152

"podStatusTime": "A String", # Time the pod status was reported in milliseconds since epoch.

153

"statusCode": "A String", # Code associated with the deployment status.

154

"statusCodeDetails": "A String", # Human-readable message associated with the status code.

155

},

156

],

157

"revision": "A String", # API proxy revision.

158

"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 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.

159

{ # Describes a routing conflict that may cause a deployment not to receive traffic at some basepath.

160

"conflictingDeployment": { # A tuple representing a basepath and the deployment containing it. # The existing basepath/deployment causing the conflict.

161

"apiProxy": "A String", # The name of the deployed proxy revision containing the basepath.

162

"basepath": "A String", # The basepath receiving traffic.

163

"environment": "A String", # The name of the environment in which the proxy is deployed.

164

"revision": "A String", # The name of the deployed proxy revision containing the basepath.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

165

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

166

"description": "A String", # A human-readable description of this conflict.

167

"environmentGroup": "A String", # The name of the environment group in which this conflict exists.

168

},

169

],

170

"state": "A String", # Current state of the deployment. This field is not populated in List APIs.

171

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<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

178

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

187

188

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

189

"apiProxy": "A String", # API proxy.

190

"deployStartTime": "A String", # Time the API proxy was marked `deployed` in the control plane in millisconds since epoch.

191

"environment": "A String", # Environment.

192

"errors": [ # Errors reported for this deployment. Populated only when state == ERROR. This field is not populated in List APIs.

193

{ # 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).

194

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

195

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

196

{

197

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

198

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

199

],

200

"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.

201

},

202

],

203

"instances": [ # Status reported by each runtime instance. This field is not populated in List APIs.

204

{ # The status of a deployment as reported by a single instance.

205

"deployedRevisions": [ # Revisions currently deployed in MPs.

206

{ # Revisions deployed in the MPs.

207

"percentage": 42, # The percentage of MP replicas reporting this revision

208

"revision": "A String", # The proxy revision reported as deployed.

209

},

210

],

211

"deployedRoutes": [ # The current routes deployed in the ingress routing table. A route which is missing will appear in missing_routes.

212

{ # A route deployed in the ingress routing table.

213

"basepath": "A String", # The basepath in the routing table.

214

"envgroup": "A String", # The envgroup where this route is installed.

215

"environment": "A String", # The destination environment. This will be empty if the route is not yet reported.

216

"percentage": 42, # The percentage of ingress replicas reporting this route.

217

},

218

],

219

"instance": "A String", # ID of the instance reporting the status.

220

},

221

],

222

"pods": [ # Status reported by runtime pods. This field is not populated for List APIs.

223

{

224

"appVersion": "A String", # Version of the application running in the pod.

225

"deploymentStatus": "A String", # Status of the deployment. Valid values include: - `deployed`: Successful. - `error` : Failed. - `pending` : Pod has not yet reported on the deployment.

226

"deploymentStatusTime": "A String", # Time the deployment status was reported in milliseconds since epoch.

227

"deploymentTime": "A String", # Time the proxy was deployed in milliseconds since epoch.

228

"podName": "A String", # Name of the pod which is reporting the status.

229

"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.

230

"podStatusTime": "A String", # Time the pod status was reported in milliseconds since epoch.

231

"statusCode": "A String", # Code associated with the deployment status.

232

"statusCodeDetails": "A String", # Human-readable message associated with the status code.

233

},

234

],

235

"revision": "A String", # API proxy revision.

236

"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 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.

237

{ # Describes a routing conflict that may cause a deployment not to receive traffic at some basepath.

238

"conflictingDeployment": { # A tuple representing a basepath and the deployment containing it. # The existing basepath/deployment causing the conflict.

239

"apiProxy": "A String", # The name of the deployed proxy revision containing the basepath.

240

"basepath": "A String", # The basepath receiving traffic.

241

"environment": "A String", # The name of the environment in which the proxy is deployed.

242

"revision": "A String", # The name of the deployed proxy revision containing the basepath.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

243

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

244

"description": "A String", # A human-readable description of this conflict.

245

"environmentGroup": "A String", # The name of the environment group in which this conflict exists.

246

},

247

],

248

"state": "A String", # Current state of the deployment. This field is not populated in List APIs.

249

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<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

256

Args:

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame^]

267

}</pre>

Bu Sun Kim