Skip to content

Commit c502728

Browse files
yoshi-automationyoshi-automation
committed
feat(run): update the api
#### run:v1 The following keys were added: - resources.operations.methods.cancel (Total Keys: 12) - schemas.Empty (Total Keys: 2) - schemas.GoogleLongrunningCancelOperationRequest (Total Keys: 2)
1 parent 22eae01 commit c502728

File tree

4 files changed

+164
-2
lines changed

4 files changed

+164
-2
lines changed

‎docs/dyn/run_v1.html

+5
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the namespaces Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="run_v1.operations.html">operations()</a></code>
84+
</p>
85+
<p class="firstline">Returns the operations Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="run_v1.projects.html">projects()</a></code>
8489
</p>

‎docs/dyn/run_v1.operations.html

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
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="run_v1.html">Cloud Run Admin API</a> . <a href="run_v1.operations.html">operations</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.</p>
80+
<p class="toc_element">
81+
<code><a href="#close">close()</a></code></p>
82+
<p class="firstline">Close httplib2 connections.</p>
83+
<h3>Method Details</h3>
84+
<div class="method">
85+
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
86+
<pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
87+
88+
Args:
89+
name: string, The name of the operation resource to be cancelled. (required)
90+
body: object, The request body.
91+
The object takes the form of:
92+
93+
{ # The request message for Operations.CancelOperation.
94+
}
95+
96+
x__xgafv: string, V1 error format.
97+
Allowed values
98+
1 - v1 error format
99+
2 - v2 error format
100+
101+
Returns:
102+
An object of the form:
103+
104+
{ # 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 `{}`.
105+
}</pre>
106+
</div>
107+
108+
<div class="method">
109+
<code class="details" id="close">close()</code>
110+
<pre>Close httplib2 connections.</pre>
111+
</div>
112+
113+
</body></html>

‎googleapiclient/discovery_cache/documents/run.v1.json

+45-1
Original file line numberDiff line numberDiff line change
@@ -833,6 +833,38 @@
833833
}
834834
}
835835
},
836+
"operations": {
837+
"methods": {
838+
"cancel": {
839+
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
840+
"flatPath": "v1/operations/{operationsId}:cancel",
841+
"httpMethod": "POST",
842+
"id": "run.operations.cancel",
843+
"parameterOrder": [
844+
"name"
845+
],
846+
"parameters": {
847+
"name": {
848+
"description": "The name of the operation resource to be cancelled.",
849+
"location": "path",
850+
"pattern": "^operations/.*$",
851+
"required": true,
852+
"type": "string"
853+
}
854+
},
855+
"path": "v1/{+name}:cancel",
856+
"request": {
857+
"$ref": "GoogleLongrunningCancelOperationRequest"
858+
},
859+
"response": {
860+
"$ref": "Empty"
861+
},
862+
"scopes": [
863+
"https://www.googleapis.com/auth/cloud-platform"
864+
]
865+
}
866+
}
867+
},
836868
"projects": {
837869
"resources": {
838870
"authorizeddomains": {
@@ -1736,7 +1768,7 @@
17361768
}
17371769
}
17381770
},
1739-
"revision": "20211015",
1771+
"revision": "20211022",
17401772
"rootUrl": "https://run.googleapis.com/",
17411773
"schemas": {
17421774
"Addressable": {
@@ -2170,6 +2202,12 @@
21702202
},
21712203
"type": "object"
21722204
},
2205+
"Empty": {
2206+
"description": "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 `{}`.",
2207+
"id": "Empty",
2208+
"properties": {},
2209+
"type": "object"
2210+
},
21732211
"EnvFromSource": {
21742212
"description": "Not supported by Cloud Run EnvFromSource represents the source of a set of ConfigMaps",
21752213
"id": "EnvFromSource",
@@ -2292,6 +2330,12 @@
22922330
},
22932331
"type": "object"
22942332
},
2333+
"GoogleLongrunningCancelOperationRequest": {
2334+
"description": "The request message for Operations.CancelOperation.",
2335+
"id": "GoogleLongrunningCancelOperationRequest",
2336+
"properties": {},
2337+
"type": "object"
2338+
},
22952339
"HTTPGetAction": {
22962340
"description": "Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests.",
22972341
"id": "HTTPGetAction",

‎googleapiclient/discovery_cache/documents/run.v1alpha1.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@
268268
}
269269
}
270270
},
271-
"revision": "20211015",
271+
"revision": "20211022",
272272
"rootUrl": "https://run.googleapis.com/",
273273
"schemas": {
274274
"ConfigMapEnvSource": {

0 commit comments

Comments
 (0)