blob: 65039ff40e7b7c9d80e06a384271c85f707972ac [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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
75<h1><a href="bigqueryreservation_v1.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
80<p class="toc_element">
81 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists operations that match the specified filter in the request. If the</p>
83<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>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
89 <pre>Deletes a long-running operation. This method indicates that the client is
90no longer interested in the operation result. It does not cancel the
91operation. If the server doesn&#x27;t support this method, it returns
92`google.rpc.Code.UNIMPLEMENTED`.
93
94Args:
95 name: string, The name of the operation resource to be deleted. (required)
96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 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
105 # empty messages in your APIs. A typical example is to use it as the request
106 # or the response type of an API method. For instance:
107 #
108 # service Foo {
109 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
110 # }
111 #
112 # The JSON representation for `Empty` is empty JSON object `{}`.
113 }</pre>
114</div>
115
116<div class="method">
117 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
118 <pre>Lists operations that match the specified filter in the request. If the
119server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`.
120
121NOTE: the `name` binding allows API services to override the binding
122to use different resource name schemes, such as `users/*/operations`. To
123override the binding, API services can add a binding such as
124`&quot;/v1/{name=users/*}/operations&quot;` to their service configuration.
125For backwards compatibility, the default name includes the operations
126collection id, however overriding users must ensure the name binding
127is the parent resource, without the operations collection id.
128
129Args:
130 name: string, The name of the operation&#x27;s parent resource. (required)
131 pageSize: integer, The standard list page size.
132 filter: string, The standard list filter.
133 pageToken: string, The standard list page token.
134 x__xgafv: string, V1 error format.
135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
138
139Returns:
140 An object of the form:
141
142 { # The response message for Operations.ListOperations.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700143 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700144 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
145 { # This resource represents a long-running operation that is the result of a
146 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700147 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
148 # contains progress information and common metadata such as create time.
149 # Some services might not provide such metadata. Any method that returns a
150 # long-running operation should document the metadata type, if any.
151 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
152 },
153 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
154 # If `true`, the operation is completed, and either `error` or `response` is
155 # available.
156 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
157 # method returns no data on success, such as `Delete`, the response is
158 # `google.protobuf.Empty`. If the original method is standard
159 # `Get`/`Create`/`Update`, the response should be the resource. For other
160 # methods, the response should have the type `XxxResponse`, where `Xxx`
161 # is the original method name. For example, if the original method name
162 # is `TakeSnapshot()`, the inferred response type is
163 # `TakeSnapshotResponse`.
164 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
165 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700166 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
167 # originally returns it. If you use the default HTTP mapping, the
168 # `name` should be a resource name ending with `operations/{unique_id}`.
169 &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.
170 # different programming environments, including REST APIs and RPC APIs. It is
171 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
172 # three pieces of data: error code, error message, and error details.
173 #
174 # You can find out more about this error model and how to work with it in the
175 # [API Design Guide](https://cloud.google.com/apis/design/errors).
176 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
177 # message types for APIs to use.
178 {
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
181 ],
182 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
183 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
184 # user-facing error message should be localized and sent in the
185 # google.rpc.Status.details field, or localized by the client.
186 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700187 },
188 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700189 }</pre>
190</div>
191
192<div class="method">
193 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
194 <pre>Retrieves the next page of results.
195
196Args:
197 previous_request: The request for the previous page. (required)
198 previous_response: The response from the request for the previous page. (required)
199
200Returns:
201 A request object that you can call &#x27;execute()&#x27; on to request the next
202 page. Returns None if there are no more items in the collection.
203 </pre>
204</div>
205
206</body></html>