Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / bigtableadmin_v2.operations.projects.operations.html
blob: 4e92fc283e80c36e91d676d3c3281767ebf889b5 [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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]85 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86 <pre>Lists operations that match the specified filter in the request. If the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]92`&quot;/v1/{name=users/*}/operations&quot;` to their service configuration.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98 name: string, The name of the operation&#x27;s parent resource. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]99 pageSize: integer, The standard list page size.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]100 filter: string, The standard list filter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]101 pageToken: string, The standard list page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106
107Returns:
108 An object of the form:
109
110 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]111 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 { # This resource represents a long-running operation that is the result of a
113 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]114 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
115 # contains progress information and common metadata such as create time.
116 # Some services might not provide such metadata. Any method that returns a
117 # long-running operation should document the metadata type, if any.
118 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
119 },
120 &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.
121 # different programming environments, including REST APIs and RPC APIs. It is
122 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
123 # three pieces of data: error code, error message, and error details.
124 #
125 # You can find out more about this error model and how to work with it in the
126 # [API Design Guide](https://cloud.google.com/apis/design/errors).
127 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
128 # message types for APIs to use.
129 {
130 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
131 },
132 ],
133 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
134 # user-facing error message should be localized and sent in the
135 # google.rpc.Status.details field, or localized by the client.
136 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
137 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139 # method returns no data on success, such as `Delete`, the response is
140 # `google.protobuf.Empty`. If the original method is standard
141 # `Get`/`Create`/`Update`, the response should be the resource. For other
142 # methods, the response should have the type `XxxResponse`, where `Xxx`
143 # is the original method name. For example, if the original method name
144 # is `TakeSnapshot()`, the inferred response type is
145 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]146 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]147 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]148 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]149 # originally returns it. If you use the default HTTP mapping, the
150 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]151 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
152 # If `true`, the operation is completed, and either `error` or `response` is
153 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 },
155 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]156 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 page. Returns None if there are no more items in the collection.
171 </pre>
172</div>
173
174</body></html>