• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.operations.html">operations</a> . <a href="bigtableadmin_v2.operations.projects.html">projects</a> . <a href="bigtableadmin_v2.operations.projects.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
79<p class="firstline">Lists operations that match the specified filter in the request. If the</p>
80<p class="toc_element">
81  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
86  <pre>Lists operations that match the specified filter in the request. If the
87server doesn't support this method, it returns `UNIMPLEMENTED`.
88
89NOTE: the `name` binding allows API services to override the binding
90to use different resource name schemes, such as `users/*/operations`. To
91override the binding, API services can add a binding such as
92`"/v1/{name=users/*}/operations"` to their service configuration.
93For backwards compatibility, the default name includes the operations
94collection id, however overriding users must ensure the name binding
95is the parent resource, without the operations collection id.
96
97Args:
98  name: string, The name of the operation's parent resource. (required)
99  pageToken: string, The standard list page token.
100  x__xgafv: string, V1 error format.
101    Allowed values
102      1 - v1 error format
103      2 - v2 error format
104  pageSize: integer, The standard list page size.
105  filter: string, The standard list filter.
106
107Returns:
108  An object of the form:
109
110    { # The response message for Operations.ListOperations.
111    "nextPageToken": "A String", # The standard List next-page token.
112    "operations": [ # A list of operations that matches the specified filter in the request.
113      { # This resource represents a long-running operation that is the result of a
114          # network API call.
115        "metadata": { # Service-specific metadata associated with the operation.  It typically
116            # contains progress information and common metadata such as create time.
117            # Some services might not provide such metadata.  Any method that returns a
118            # long-running operation should document the metadata type, if any.
119          "a_key": "", # Properties of the object. Contains field @type with type URL.
120        },
121        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
122            # different programming environments, including REST APIs and RPC APIs. It is
123            # used by [gRPC](https://github.com/grpc). The error model is designed to be:
124            #
125            # - Simple to use and understand for most users
126            # - Flexible enough to meet unexpected needs
127            #
128            # # Overview
129            #
130            # The `Status` message contains three pieces of data: error code, error
131            # message, and error details. The error code should be an enum value of
132            # google.rpc.Code, but it may accept additional error codes if needed.  The
133            # error message should be a developer-facing English message that helps
134            # developers *understand* and *resolve* the error. If a localized user-facing
135            # error message is needed, put the localized message in the error details or
136            # localize it in the client. The optional error details may contain arbitrary
137            # information about the error. There is a predefined set of error detail types
138            # in the package `google.rpc` that can be used for common error conditions.
139            #
140            # # Language mapping
141            #
142            # The `Status` message is the logical representation of the error model, but it
143            # is not necessarily the actual wire format. When the `Status` message is
144            # exposed in different client libraries and different wire protocols, it can be
145            # mapped differently. For example, it will likely be mapped to some exceptions
146            # in Java, but more likely mapped to some error codes in C.
147            #
148            # # Other uses
149            #
150            # The error model and the `Status` message can be used in a variety of
151            # environments, either with or without APIs, to provide a
152            # consistent developer experience across different environments.
153            #
154            # Example uses of this error model include:
155            #
156            # - Partial errors. If a service needs to return partial errors to the client,
157            #     it may embed the `Status` in the normal response to indicate the partial
158            #     errors.
159            #
160            # - Workflow errors. A typical workflow has multiple steps. Each step may
161            #     have a `Status` message for error reporting.
162            #
163            # - Batch operations. If a client uses batch request and batch response, the
164            #     `Status` message should be used directly inside batch response, one for
165            #     each error sub-response.
166            #
167            # - Asynchronous operations. If an API call embeds asynchronous operation
168            #     results in its response, the status of those operations should be
169            #     represented directly using the `Status` message.
170            #
171            # - Logging. If some API errors are stored in logs, the message `Status` could
172            #     be used directly after any stripping needed for security/privacy reasons.
173          "message": "A String", # A developer-facing error message, which should be in English. Any
174              # user-facing error message should be localized and sent in the
175              # google.rpc.Status.details field, or localized by the client.
176          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
177          "details": [ # A list of messages that carry the error details.  There is a common set of
178              # message types for APIs to use.
179            {
180              "a_key": "", # Properties of the object. Contains field @type with type URL.
181            },
182          ],
183        },
184        "done": True or False, # If the value is `false`, it means the operation is still in progress.
185            # If `true`, the operation is completed, and either `error` or `response` is
186            # available.
187        "response": { # The normal response of the operation in case of success.  If the original
188            # method returns no data on success, such as `Delete`, the response is
189            # `google.protobuf.Empty`.  If the original method is standard
190            # `Get`/`Create`/`Update`, the response should be the resource.  For other
191            # methods, the response should have the type `XxxResponse`, where `Xxx`
192            # is the original method name.  For example, if the original method name
193            # is `TakeSnapshot()`, the inferred response type is
194            # `TakeSnapshotResponse`.
195          "a_key": "", # Properties of the object. Contains field @type with type URL.
196        },
197        "name": "A String", # The server-assigned name, which is only unique within the same service that
198            # originally returns it. If you use the default HTTP mapping, the
199            # `name` should have the format of `operations/some/unique/name`.
200      },
201    ],
202  }</pre>
203</div>
204
205<div class="method">
206    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
207  <pre>Retrieves the next page of results.
208
209Args:
210  previous_request: The request for the previous page. (required)
211  previous_response: The response from the request for the previous page. (required)
212
213Returns:
214  A request object that you can call 'execute()' on to request the next
215  page. Returns None if there are no more items in the collection.
216    </pre>
217</div>
218
219</body></html>