Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / cloudresourcemanager_v1.operations.html
blob: c936baa4a822168ebad73bfc7ac92678a4ed3ee6 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -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="cloudresourcemanager_v1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]79<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="get">get(name, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]83 <pre>Gets the latest state of a long-running operation. Clients can use this
84method to poll the operation result at intervals as recommended by the API
85service.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]86
87Args:
88 name: string, The name of the operation resource. (required)
89 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]90 Allowed values
91 1 - v1 error format
92 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]93
94Returns:
95 An object of the form:
96
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]97 { # This resource represents a long-running operation that is the result of a
98 # network API call.
99 "metadata": { # Service-specific metadata associated with the operation. It typically
100 # contains progress information and common metadata such as create time.
101 # Some services might not provide such metadata. Any method that returns a
102 # long-running operation should document the metadata type, if any.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]103 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]104 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]105 "done": True or False, # If the value is `false`, it means the operation is still in progress.
106 # If true, the operation is completed, and either `error` or `response` is
107 # available.
108 "response": { # The normal response of the operation in case of success. If the original
109 # method returns no data on success, such as `Delete`, the response is
110 # `google.protobuf.Empty`. If the original method is standard
111 # `Get`/`Create`/`Update`, the response should be the resource. For other
112 # methods, the response should have the type `XxxResponse`, where `Xxx`
113 # is the original method name. For example, if the original method name
114 # is `TakeSnapshot()`, the inferred response type is
115 # `TakeSnapshotResponse`.
116 "a_key": "", # Properties of the object. Contains field @type with type URL.
117 },
118 "name": "A String", # The server-assigned name, which is only unique within the same service that
119 # originally returns it. If you use the default HTTP mapping, the
120 # `name` should have the format of `operations/some/unique/name`.
121 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
122 # programming environments, including REST APIs and RPC APIs. It is used by
123 # [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 message,
131 # 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` which 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 purpose.
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.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]176 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]177 "details": [ # A list of messages that carry the error details. There will be a
178 # common set of message types for APIs to use.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]179 {
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]180 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]181 },
182 ],
183 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]184 }</pre>
185</div>
186
187</body></html>