Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 860a6378c538d8e2e424c7be150b41ba28120387 / . / docs / dyn / dataproc_v1.projects.regions.operations.html
blob: 80af957800398d5ac343c138527aac499125ba72 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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_v1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.regions.html">regions</a> . <a href="dataproc_v1.projects.regions.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>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[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 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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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. 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>
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 can 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>
88<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 below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.</p>
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, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[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 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`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]96
97Args:
98 name: string, The name of the operation resource to be cancelled. (required)
99 x__xgafv: string, V1 error format.
100
101Returns:
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="delete">delete(name, x__xgafv=None)</code>
110 <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't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
111
112Args:
113 name: string, The name of the operation resource to be deleted. (required)
114 x__xgafv: string, V1 error format.
115
116Returns:
117 An object of the form:
118
119 { # 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 `{}`.
120 }</pre>
121</div>
122
123<div class="method">
124 <code class="details" id="get">get(name, x__xgafv=None)</code>
125 <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.
126
127Args:
128 name: string, The name of the operation resource. (required)
129 x__xgafv: string, V1 error format.
130
131Returns:
132 An object of the form:
133
134 { # This resource represents a long-running operation that is the result of a network API call.
135 "response": { # 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`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]136 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]138 "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: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `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` which can be used for common error conditions. # Language mapping The `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 uses The 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: - 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. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - 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. - 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. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]139 "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.
140 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
141 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
142 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]143 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]144 },
145 ],
146 },
147 "done": 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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]148 "name": "A String", # 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 have the format of `operations/some/unique/name`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]149 "metadata": { # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]150 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]151 },
152 }</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
157 <pre>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 below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.
158
159Args:
160 name: string, The name of the operation collection. (required)
161 pageSize: integer, The standard list page size.
162 filter: string, The standard list filter.
163 pageToken: string, The standard list page token.
164 x__xgafv: string, V1 error format.
165
166Returns:
167 An object of the form:
168
169 { # The response message for Operations.ListOperations.
170 "operations": [ # A list of operations that matches the specified filter in the request.
171 { # This resource represents a long-running operation that is the result of a network API call.
172 "response": { # 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`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]173 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]174 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]175 "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: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `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` which can be used for common error conditions. # Language mapping The `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 uses The 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: - 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. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - 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. - 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. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]176 "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.
177 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
178 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
179 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]180 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]181 },
182 ],
183 },
184 "done": 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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]185 "name": "A String", # 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 have the format of `operations/some/unique/name`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]186 "metadata": { # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]187 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]188 },
189 },
190 ],
191 "nextPageToken": "A String", # The standard List next-page token.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
197 <pre>Retrieves the next page of results.
198
199Args:
200 previous_request: The request for the previous page. (required)
201 previous_response: The response from the request for the previous page. (required)
202
203Returns:
204 A request object that you can call 'execute()' on to request the next
205 page. Returns None if there are no more items in the collection.
206 </pre>
207</div>
208
209</body></html>