blob: 1c8691fd260cbf28e1cf5b8beee1d1e3bfce50d5 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -07001<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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070075<h1><a href="servicemanagement_v1.html">Service Management API</a> . <a href="servicemanagement_v1.operations.html">operations</a></h1>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040080<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070081 <code><a href="#list">list(pageSize=None, name=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -070082<p class="firstline">Lists service operations that match the specified filter in the request.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040083<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -070086<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(name, x__xgafv=None)</code>
89 <pre>Gets the latest state of a long-running operation. Clients can use this
90method to poll the operation result at intervals as recommended by the API
91service.
92
93Args:
94 name: string, The name of the operation resource. (required)
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99
100Returns:
101 An object of the form:
102
103 { # This resource represents a long-running operation that is the result of a
104 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700105 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
106 # different programming environments, including REST APIs and RPC APIs. It is
107 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
108 # three pieces of data: error code, error message, and error details.
109 #
110 # You can find out more about this error model and how to work with it in the
111 # [API Design Guide](https://cloud.google.com/apis/design/errors).
112 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
113 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
114 # user-facing error message should be localized and sent in the
115 # google.rpc.Status.details field, or localized by the client.
116 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
117 # message types for APIs to use.
118 {
119 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
120 },
121 ],
122 },
123 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
124 # originally returns it. If you use the default HTTP mapping, the
125 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700126 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400127 # contains progress information and common metadata such as create time.
128 # Some services might not provide such metadata. Any method that returns a
129 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700130 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400131 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700132 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Dan O'Mearadd494642020-05-01 07:42:23 -0700133 # If `true`, the operation is completed, and either `error` or `response` is
134 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700135 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700136 # method returns no data on success, such as `Delete`, the response is
137 # `google.protobuf.Empty`. If the original method is standard
138 # `Get`/`Create`/`Update`, the response should be the resource. For other
139 # methods, the response should have the type `XxxResponse`, where `Xxx`
140 # is the original method name. For example, if the original method name
141 # is `TakeSnapshot()`, the inferred response type is
142 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700143 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700144 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700145 }</pre>
146</div>
147
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400148<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700149 <code class="details" id="list">list(pageSize=None, name=None, pageToken=None, filter=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700150 <pre>Lists service operations that match the specified filter in the request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400151
152Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700153 pageSize: integer, The maximum number of operations to return. If unspecified, defaults to
15450. The maximum value is 100.
155 name: string, Not used.
156 pageToken: string, The standard list page token.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700157 filter: string, A string for filtering Operations.
Dan O'Mearadd494642020-05-01 07:42:23 -0700158 The following filter fields are supported&amp;#58;
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700159
Dan O'Mearadd494642020-05-01 07:42:23 -0700160 * serviceName&amp;#58; Required. Only `=` operator is allowed.
161 * startTime&amp;#58; The time this job was started, in ISO 8601 format.
162 Allowed operators are `&gt;=`, `&gt;`, `&lt;=`, and `&lt;`.
163 * status&amp;#58; Can be `done`, `in_progress`, or `failed`. Allowed
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700164 operators are `=`, and `!=`.
165
166 Filter expression supports conjunction (AND) and disjunction (OR)
167 logical operators. However, the serviceName restriction must be at the
168 top-level and can only be combined with other restrictions via the AND
169 logical operator.
170
Dan O'Mearadd494642020-05-01 07:42:23 -0700171 Examples&amp;#58;
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700172
173 * `serviceName={some-service}.googleapis.com`
Bu Sun Kim65020912020-05-20 12:08:20 -0700174 * `serviceName={some-service}.googleapis.com AND startTime&gt;=&quot;2017-02-01&quot;`
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700175 * `serviceName={some-service}.googleapis.com AND status=done`
Bu Sun Kim65020912020-05-20 12:08:20 -0700176 * `serviceName={some-service}.googleapis.com AND (status=done OR startTime&gt;=&quot;2017-02-01&quot;)`
Bu Sun Kim65020912020-05-20 12:08:20 -0700177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400181
182Returns:
183 An object of the form:
184
185 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700186 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400187 { # This resource represents a long-running operation that is the result of a
188 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700189 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
190 # different programming environments, including REST APIs and RPC APIs. It is
191 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
192 # three pieces of data: error code, error message, and error details.
193 #
194 # You can find out more about this error model and how to work with it in the
195 # [API Design Guide](https://cloud.google.com/apis/design/errors).
196 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
197 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
198 # user-facing error message should be localized and sent in the
199 # google.rpc.Status.details field, or localized by the client.
200 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
201 # message types for APIs to use.
202 {
203 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
204 },
205 ],
206 },
207 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
208 # originally returns it. If you use the default HTTP mapping, the
209 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700210 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400211 # contains progress information and common metadata such as create time.
212 # Some services might not provide such metadata. Any method that returns a
213 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700214 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400215 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Dan O'Mearadd494642020-05-01 07:42:23 -0700217 # If `true`, the operation is completed, and either `error` or `response` is
218 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700219 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700220 # method returns no data on success, such as `Delete`, the response is
221 # `google.protobuf.Empty`. If the original method is standard
222 # `Get`/`Create`/`Update`, the response should be the resource. For other
223 # methods, the response should have the type `XxxResponse`, where `Xxx`
224 # is the original method name. For example, if the original method name
225 # is `TakeSnapshot()`, the inferred response type is
226 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700227 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700228 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400229 },
230 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700231 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400232 }</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700244 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400245 page. Returns None if there are no more items in the collection.
246 </pre>
247</div>
248
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700249</body></html>