Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 421f03b

Browse files
yoshi-automationyoshi-automation
committedOct 25, 2022
feat(dataproc): update the api
#### dataproc:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.list (Total Keys: 18)
1 parent ca9cc14 commit 421f03b

6 files changed

+403
-49
lines changed
 

‎docs/dyn/dataproc_v1.projects.locations.html

+5
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ <h2>Instance Methods</h2>
8484
</p>
8585
<p class="firstline">Returns the batches Resource.</p>
8686

87+
<p class="toc_element">
88+
<code><a href="dataproc_v1.projects.locations.operations.html">operations()</a></code>
89+
</p>
90+
<p class="firstline">Returns the operations Resource.</p>
91+
8792
<p class="toc_element">
8893
<code><a href="dataproc_v1.projects.locations.workflowTemplates.html">workflowTemplates()</a></code>
8994
</p>

‎docs/dyn/dataproc_v1.projects.locations.operations.html

+229
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,229 @@
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="dataproc_v1.html">Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.locations.html">locations</a> . <a href="dataproc_v1.projects.locations.operations.html">operations</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#cancel">cancel(name, 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+
<p class="toc_element">
84+
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.</p>
86+
<p class="toc_element">
87+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
89+
<p class="toc_element">
90+
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91+
<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</p>
92+
<p class="toc_element">
93+
<code><a href="#list_next">list_next()</a></code></p>
94+
<p class="firstline">Retrieves the next page of results.</p>
95+
<h3>Method Details</h3>
96+
<div class="method">
97+
<code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
98+
<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.
99+
100+
Args:
101+
name: string, The name of the operation resource to be cancelled. (required)
102+
x__xgafv: string, V1 error format.
103+
Allowed values
104+
1 - v1 error format
105+
2 - v2 error format
106+
107+
Returns:
108+
An object of the form:
109+
110+
{ # 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); }
111+
}</pre>
112+
</div>
113+
114+
<div class="method">
115+
<code class="details" id="close">close()</code>
116+
<pre>Close httplib2 connections.</pre>
117+
</div>
118+
119+
<div class="method">
120+
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
121+
<pre>Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn&#x27;t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
122+
123+
Args:
124+
name: string, The name of the operation resource to be deleted. (required)
125+
x__xgafv: string, V1 error format.
126+
Allowed values
127+
1 - v1 error format
128+
2 - v2 error format
129+
130+
Returns:
131+
An object of the form:
132+
133+
{ # 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); }
134+
}</pre>
135+
</div>
136+
137+
<div class="method">
138+
<code class="details" id="get">get(name, x__xgafv=None)</code>
139+
<pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
140+
141+
Args:
142+
name: string, The name of the operation resource. (required)
143+
x__xgafv: string, V1 error format.
144+
Allowed values
145+
1 - v1 error format
146+
2 - v2 error format
147+
148+
Returns:
149+
An object of the form:
150+
151+
{ # This resource represents a long-running operation that is the result of a network API call.
152+
&quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
153+
&quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
154+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
155+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
156+
{
157+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
158+
},
159+
],
160+
&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.
161+
},
162+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
163+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
164+
},
165+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
166+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
167+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
168+
},
169+
}</pre>
170+
</div>
171+
172+
<div class="method">
173+
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
174+
<pre>Lists operations that match the specified filter in the request. If the server doesn&#x27;t support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as &quot;/v1/{name=users/*}/operations&quot; to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
175+
176+
Args:
177+
name: string, The name of the operation&#x27;s parent resource. (required)
178+
filter: string, The standard list filter.
179+
pageSize: integer, The standard list page size.
180+
pageToken: string, The standard list page token.
181+
x__xgafv: string, V1 error format.
182+
Allowed values
183+
1 - v1 error format
184+
2 - v2 error format
185+
186+
Returns:
187+
An object of the form:
188+
189+
{ # The response message for Operations.ListOperations.
190+
&quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
191+
&quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
192+
{ # This resource represents a long-running operation that is the result of a network API call.
193+
&quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
194+
&quot;error&quot;: { # 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). # The error result of the operation in case of failure or cancellation.
195+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
196+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
197+
{
198+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
199+
},
200+
],
201+
&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.
202+
},
203+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
204+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
205+
},
206+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
207+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
208+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
209+
},
210+
},
211+
],
212+
}</pre>
213+
</div>
214+
215+
<div class="method">
216+
<code class="details" id="list_next">list_next()</code>
217+
<pre>Retrieves the next page of results.
218+
219+
Args:
220+
previous_request: The request for the previous page. (required)
221+
previous_response: The response from the request for the previous page. (required)
222+
223+
Returns:
224+
A request object that you can call &#x27;execute()&#x27; on to request the next
225+
page. Returns None if there are no more items in the collection.
226+
</pre>
227+
</div>
228+
229+
</body></html>

‎docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html

+14-14
Large diffs are not rendered by default.

‎docs/dyn/dataproc_v1.projects.regions.clusters.html

+16-16
Large diffs are not rendered by default.

‎docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html

+14-14
Large diffs are not rendered by default.

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

+125-5
Original file line numberDiff line numberDiff line change
@@ -467,6 +467,126 @@
467467
}
468468
}
469469
},
470+
"operations": {
471+
"methods": {
472+
"cancel": {
473+
"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.",
474+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
475+
"httpMethod": "POST",
476+
"id": "dataproc.projects.locations.operations.cancel",
477+
"parameterOrder": [
478+
"name"
479+
],
480+
"parameters": {
481+
"name": {
482+
"description": "The name of the operation resource to be cancelled.",
483+
"location": "path",
484+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
485+
"required": true,
486+
"type": "string"
487+
}
488+
},
489+
"path": "v1/{+name}:cancel",
490+
"response": {
491+
"$ref": "Empty"
492+
},
493+
"scopes": [
494+
"https://www.googleapis.com/auth/cloud-platform"
495+
]
496+
},
497+
"delete": {
498+
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.",
499+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
500+
"httpMethod": "DELETE",
501+
"id": "dataproc.projects.locations.operations.delete",
502+
"parameterOrder": [
503+
"name"
504+
],
505+
"parameters": {
506+
"name": {
507+
"description": "The name of the operation resource to be deleted.",
508+
"location": "path",
509+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
510+
"required": true,
511+
"type": "string"
512+
}
513+
},
514+
"path": "v1/{+name}",
515+
"response": {
516+
"$ref": "Empty"
517+
},
518+
"scopes": [
519+
"https://www.googleapis.com/auth/cloud-platform"
520+
]
521+
},
522+
"get": {
523+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
524+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
525+
"httpMethod": "GET",
526+
"id": "dataproc.projects.locations.operations.get",
527+
"parameterOrder": [
528+
"name"
529+
],
530+
"parameters": {
531+
"name": {
532+
"description": "The name of the operation resource.",
533+
"location": "path",
534+
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
535+
"required": true,
536+
"type": "string"
537+
}
538+
},
539+
"path": "v1/{+name}",
540+
"response": {
541+
"$ref": "Operation"
542+
},
543+
"scopes": [
544+
"https://www.googleapis.com/auth/cloud-platform"
545+
]
546+
},
547+
"list": {
548+
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
549+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
550+
"httpMethod": "GET",
551+
"id": "dataproc.projects.locations.operations.list",
552+
"parameterOrder": [
553+
"name"
554+
],
555+
"parameters": {
556+
"filter": {
557+
"description": "The standard list filter.",
558+
"location": "query",
559+
"type": "string"
560+
},
561+
"name": {
562+
"description": "The name of the operation's parent resource.",
563+
"location": "path",
564+
"pattern": "^projects/[^/]+/locations/[^/]+/operations$",
565+
"required": true,
566+
"type": "string"
567+
},
568+
"pageSize": {
569+
"description": "The standard list page size.",
570+
"format": "int32",
571+
"location": "query",
572+
"type": "integer"
573+
},
574+
"pageToken": {
575+
"description": "The standard list page token.",
576+
"location": "query",
577+
"type": "string"
578+
}
579+
},
580+
"path": "v1/{+name}",
581+
"response": {
582+
"$ref": "ListOperationsResponse"
583+
},
584+
"scopes": [
585+
"https://www.googleapis.com/auth/cloud-platform"
586+
]
587+
}
588+
}
589+
},
470590
"workflowTemplates": {
471591
"methods": {
472592
"create": {
@@ -2444,7 +2564,7 @@
24442564
}
24452565
}
24462566
},
2447-
"revision": "20220921",
2567+
"revision": "20221017",
24482568
"rootUrl": "https://dataproc.googleapis.com/",
24492569
"schemas": {
24502570
"AcceleratorConfig": {
@@ -3527,11 +3647,11 @@
35273647
"type": "string"
35283648
},
35293649
"preemptible": {
3530-
"description": "Optional. Whether the nodes are created as preemptible VM instances (https://cloud.google.com/compute/docs/instances/preemptible). Preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).",
3650+
"description": "Optional. Whether the nodes are created as legacy preemptible VM instances (https://cloud.google.com/compute/docs/instances/preemptible). Also see Spot VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).",
35313651
"type": "boolean"
35323652
},
35333653
"spot": {
3534-
"description": "Optional. Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.",
3654+
"description": "Optional. Whether the nodes are created as Spot VM instances (https://cloud.google.com/compute/docs/instances/spot). Spot VMs are the latest update to legacy preemptible VMs. Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).",
35353655
"type": "boolean"
35363656
}
35373657
},
@@ -3846,8 +3966,8 @@
38463966
"enumDescriptions": [
38473967
"Preemptibility is unspecified, the system will choose the appropriate setting for each instance group.",
38483968
"Instances are non-preemptible.This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups.",
3849-
"Instances are preemptible.This option is allowed only for secondary worker groups.",
3850-
"Instances are Spot VMsThis option is allowed only for secondary worker groups. See Spot VMs (https://cloud.google.com/compute/docs/instances/spot)."
3969+
"Instances are preemptible (https://cloud.google.com/compute/docs/instances/preemptible).This option is allowed only for secondary worker (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) groups.",
3970+
"Instances are Spot VMs (https://cloud.google.com/compute/docs/instances/spot).This option is allowed only for secondary worker (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) groups. Spot VMs are the latest version of preemptible VMs (https://cloud.google.com/compute/docs/instances/preemptible), and provide additional features."
38513971
],
38523972
"type": "string"
38533973
}

0 commit comments

Comments
 (0)
Please sign in to comment.