Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / dyn / dataproc_v1alpha1.operations.html
blob: c851cc77534615a6e427b19a858e8c1a18a001d1 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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="dataproc_v1alpha1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1alpha1.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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 may use Operations.GetOperation or other methods to check whether the cancellation succeeded or the operation completed despite cancellation.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a long-running operation. It indicates the client is no longer interested in the operation result. It does not cancel the operation.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.</p>
86<p class="toc_element">
87 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="cancel">cancel(name, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]95 <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't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients may use Operations.GetOperation or other methods to check whether the cancellation succeeded or the operation completed despite cancellation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]96
97Args:
98 name: string, The name of the operation resource to be cancelled. (required)
99 body: object, The request body. (required)
100 The object takes the form of:
101
102{ # The request message for Operations.CancelOperation.
103 }
104
105 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]109
110Returns:
111 An object of the form:
112
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]113 { # 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:
114 # service Foo {
115 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
116 # }
117 # The JSON representation for Empty is empty JSON object {}.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]118 }</pre>
119</div>
120
121<div class="method">
122 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
123 <pre>Deletes a long-running operation. It indicates the client is no longer interested in the operation result. It does not cancel the operation.
124
125Args:
126 name: string, The name of the operation resource to be deleted. (required)
127 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]131
132Returns:
133 An object of the form:
134
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]135 { # 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:
136 # service Foo {
137 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
138 # }
139 # The JSON representation for Empty is empty JSON object {}.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]140 }</pre>
141</div>
142
143<div class="method">
144 <code class="details" id="get">get(name, x__xgafv=None)</code>
145 <pre>Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.
146
147Args:
148 name: string, The operation resource name. (required)
149 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]153
154Returns:
155 An object of the form:
156
157 { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]158 "metadata": { # Service-specific metadata associated with the operation.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]159 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]160 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]161 "error": { # 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). The error model is designed to be: # The error result of the operation in case of failure.
162 # Simple to use and understand for most users
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]163 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]164 # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]165 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]166 # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
167 # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
168 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]169 "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.
170 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
171 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
172 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]173 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]174 },
175 ],
176 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]177 "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
178 "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
179 "a_key": "", # Properties of the object. Contains field @type with type URL.
180 },
181 "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]187 <pre>Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]188
189Args:
190 name: string, The operation collection name. (required)
191 pageSize: integer, The standard List page size.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]192 filter: string, Required A JSON object that contains filters for the list operation, in the format {"key1":"value1","key2":"value2", ..., }. Possible keys include project_id, cluster_name, and operation_state_matcher.If project_id is set, requests the list of operations that belong to the specified Google Cloud Platform project ID. This key is required.If cluster_name is set, requests the list of operations that were submitted to the specified cluster name. This key is optional.If operation_state_matcher is set, requests the list of operations that match one of the following status options: ALL, ACTIVE, or NON_ACTIVE.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]193 pageToken: string, The standard List page token.
194 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]198
199Returns:
200 An object of the form:
201
202 { # The response message for Operations.ListOperations.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]203 "nextPageToken": "A String", # The standard List next-page token.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]204 "operations": [ # A list of operations that match the specified filter in the request.
205 { # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]206 "metadata": { # Service-specific metadata associated with the operation.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]207 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]208 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]209 "error": { # 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). The error model is designed to be: # The error result of the operation in case of failure.
210 # Simple to use and understand for most users
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]211 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]212 # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]213 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]214 # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
215 # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
216 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]217 "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.
218 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
219 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
220 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]221 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]222 },
223 ],
224 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]225 "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
226 "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
227 "a_key": "", # Properties of the object. Contains field @type with type URL.
228 },
229 "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]230 },
231 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]232 }</pre>
233</div>
234
235<div class="method">
236 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
237 <pre>Retrieves the next page of results.
238
239Args:
240 previous_request: The request for the previous page. (required)
241 previous_response: The response from the request for the previous page. (required)
242
243Returns:
244 A request object that you can call 'execute()' on to request the next
245 page. Returns None if there are no more items in the collection.
246 </pre>
247</div>
248
249</body></html>