Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / bigtableadmin_v2.operations.projects.operations.html
blob: 5ea25075dfcecf8ceb88bc789b132b22dd33cc39 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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="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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 "operations": [ # A list of operations that matches the specified filter in the request.
112 { # This resource represents a long-running operation that is the result of a
113 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]114 "response": { # The normal response of the operation in case of success. If the original
115 # method returns no data on success, such as `Delete`, the response is
116 # `google.protobuf.Empty`. If the original method is standard
117 # `Get`/`Create`/`Update`, the response should be the resource. For other
118 # methods, the response should have the type `XxxResponse`, where `Xxx`
119 # is the original method name. For example, if the original method name
120 # is `TakeSnapshot()`, the inferred response type is
121 # `TakeSnapshotResponse`.
122 "a_key": "", # Properties of the object. Contains field @type with type URL.
123 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 "metadata": { # Service-specific metadata associated with the operation. It typically
125 # contains progress information and common metadata such as create time.
126 # Some services might not provide such metadata. Any method that returns a
127 # long-running operation should document the metadata type, if any.
128 "a_key": "", # Properties of the object. Contains field @type with type URL.
129 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 "done": True or False, # If the value is `false`, it means the operation is still in progress.
131 # If `true`, the operation is completed, and either `error` or `response` is
132 # available.
133 "name": "A String", # The server-assigned name, which is only unique within the same service that
134 # originally returns it. If you use the default HTTP mapping, the
135 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 "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.
137 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]138 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
139 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141 # You can find out more about this error model and how to work with it in the
142 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 "message": "A String", # A developer-facing error message, which should be in English. Any
144 # user-facing error message should be localized and sent in the
145 # google.rpc.Status.details field, or localized by the client.
146 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
147 "details": [ # A list of messages that carry the error details. There is a common set of
148 # message types for APIs to use.
149 {
150 "a_key": "", # Properties of the object. Contains field @type with type URL.
151 },
152 ],
153 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 },
155 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 "nextPageToken": "A String", # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
162 <pre>Retrieves the next page of results.
163
164Args:
165 previous_request: The request for the previous page. (required)
166 previous_response: The response from the request for the previous page. (required)
167
168Returns:
169 A request object that you can call 'execute()' on to request the next
170 page. Returns None if there are no more items in the collection.
171 </pre>
172</div>
173
174</body></html>