Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / bigtableadmin_v2.operations.html
blob: 047458852d7a80a094d7156af1f515c59ebd395d [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="bigtableadmin_v2.operations.projects.html">projects()</a></code>
79</p>
80<p class="firstline">Returns the projects Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p>
84<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
91<h3>Method Details</h3>
92<div class="method">
93 <code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
94 <pre>Starts asynchronous cancellation on a long-running operation. The server
95makes a best effort to cancel the operation, but success is not
96guaranteed. If the server doesn't support this method, it returns
97`google.rpc.Code.UNIMPLEMENTED`. Clients can use
98Operations.GetOperation or
99other methods to check whether the cancellation succeeded or whether the
100operation completed despite cancellation. On successful cancellation,
101the operation is not deleted; instead, it becomes an operation with
102an Operation.error value with a google.rpc.Status.code of 1,
103corresponding to `Code.CANCELLED`.
104
105Args:
106 name: string, The name of the operation resource to be cancelled. (required)
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
111
112Returns:
113 An object of the form:
114
115 { # A generic empty message that you can re-use to avoid defining duplicated
116 # empty messages in your APIs. A typical example is to use it as the request
117 # or the response type of an API method. For instance:
118 #
119 # service Foo {
120 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
121 # }
122 #
123 # The JSON representation for `Empty` is empty JSON object `{}`.
124 }</pre>
125</div>
126
127<div class="method">
128 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
129 <pre>Deletes a long-running operation. This method indicates that the client is
130no longer interested in the operation result. It does not cancel the
131operation. If the server doesn't support this method, it returns
132`google.rpc.Code.UNIMPLEMENTED`.
133
134Args:
135 name: string, The name of the operation resource to be deleted. (required)
136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141Returns:
142 An object of the form:
143
144 { # A generic empty message that you can re-use to avoid defining duplicated
145 # empty messages in your APIs. A typical example is to use it as the request
146 # or the response type of an API method. For instance:
147 #
148 # service Foo {
149 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
150 # }
151 #
152 # The JSON representation for `Empty` is empty JSON object `{}`.
153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="get">get(name, x__xgafv=None)</code>
158 <pre>Gets the latest state of a long-running operation. Clients can use this
159method to poll the operation result at intervals as recommended by the API
160service.
161
162Args:
163 name: string, The name of the operation resource. (required)
164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
168
169Returns:
170 An object of the form:
171
172 { # This resource represents a long-running operation that is the result of a
173 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]174 "response": { # The normal response of the operation in case of success. If the original
175 # method returns no data on success, such as `Delete`, the response is
176 # `google.protobuf.Empty`. If the original method is standard
177 # `Get`/`Create`/`Update`, the response should be the resource. For other
178 # methods, the response should have the type `XxxResponse`, where `Xxx`
179 # is the original method name. For example, if the original method name
180 # is `TakeSnapshot()`, the inferred response type is
181 # `TakeSnapshotResponse`.
182 "a_key": "", # Properties of the object. Contains field @type with type URL.
183 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 "metadata": { # Service-specific metadata associated with the operation. It typically
185 # contains progress information and common metadata such as create time.
186 # Some services might not provide such metadata. Any method that returns a
187 # long-running operation should document the metadata type, if any.
188 "a_key": "", # Properties of the object. Contains field @type with type URL.
189 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]190 "done": True or False, # If the value is `false`, it means the operation is still in progress.
191 # If `true`, the operation is completed, and either `error` or `response` is
192 # available.
193 "name": "A String", # The server-assigned name, which is only unique within the same service that
194 # originally returns it. If you use the default HTTP mapping, the
195 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 "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.
197 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]198 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
199 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]201 # You can find out more about this error model and how to work with it in the
202 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 "message": "A String", # A developer-facing error message, which should be in English. Any
204 # user-facing error message should be localized and sent in the
205 # google.rpc.Status.details field, or localized by the client.
206 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
207 "details": [ # A list of messages that carry the error details. There is a common set of
208 # message types for APIs to use.
209 {
210 "a_key": "", # Properties of the object. Contains field @type with type URL.
211 },
212 ],
213 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 }</pre>
215</div>
216
217</body></html>