Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / bigtableadmin_v2.projects.instances.appProfiles.html
blob: daf81af0cbe18475ca6908cb3b65c0ae6ec953de [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.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.appProfiles.html">appProfiles</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, appProfileId=None, ignoreWarnings=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates an app profile within an instance.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, ignoreWarnings=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an app profile from an instance.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets information about an app profile.</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Lists information about app profiles in an instance.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]93 <code><a href="#patch">patch(name, body=None, updateMask=None, ignoreWarnings=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Updates an app profile within an instance.</p>
95<h3>Method Details</h3>
96<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97 <code class="details" id="create">create(parent, body=None, appProfileId=None, ignoreWarnings=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <pre>Creates an app profile within an instance.
99
100Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 parent: string, Required. The unique name of the instance in which to create the new app profile.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103`projects/{project}/instances/{instance}`. (required)
104 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 The object takes the form of:
106
107{ # A configuration object describing how Cloud Bigtable should treat traffic
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 # from a particular end user application.
109 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
110 # will fail over to the nearest cluster that is available in the event of
111 # transient errors or delays. Clusters in a region are considered
112 # equidistant. Choosing this option sacrifices read-your-writes consistency
113 # to improve availability.
114 },
115 &quot;name&quot;: &quot;A String&quot;, # (`OutputOnly`)
116 # The unique name of the app profile. Values are of the form
117 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/appProfiles/_a-zA-Z0-9*`.
118 &quot;description&quot;: &quot;A String&quot;, # Optional long form description of the use case for this AppProfile.
119 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the
120 # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
121 # fail the request if there has been a modification in the mean time. The
122 # `update_mask` of the request need not include `etag` for this protection
123 # to apply.
124 # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
125 # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
126 # details.
127 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
128 # This option preserves read-your-writes consistency but does not improve
129 # availability.
130 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
131 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
132 # allowed by this app profile. It is unsafe to send these requests to
133 # the same table/row/column in multiple clusters.
134 },
135}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]137 appProfileId: string, Required. The ID to be used when referring to the new app profile within its
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138instance, e.g., just `myprofile` rather than
139`projects/myproject/instances/myinstance/appProfiles/myprofile`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 ignoreWarnings: boolean, If true, ignore safety checks when creating the app profile.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 { # A configuration object describing how Cloud Bigtable should treat traffic
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 # from a particular end user application.
151 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
152 # will fail over to the nearest cluster that is available in the event of
153 # transient errors or delays. Clusters in a region are considered
154 # equidistant. Choosing this option sacrifices read-your-writes consistency
155 # to improve availability.
156 },
157 &quot;name&quot;: &quot;A String&quot;, # (`OutputOnly`)
158 # The unique name of the app profile. Values are of the form
159 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/appProfiles/_a-zA-Z0-9*`.
160 &quot;description&quot;: &quot;A String&quot;, # Optional long form description of the use case for this AppProfile.
161 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the
162 # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
163 # fail the request if there has been a modification in the mean time. The
164 # `update_mask` of the request need not include `etag` for this protection
165 # to apply.
166 # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
167 # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
168 # details.
169 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
170 # This option preserves read-your-writes consistency but does not improve
171 # availability.
172 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
173 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
174 # allowed by this app profile. It is unsafe to send these requests to
175 # the same table/row/column in multiple clusters.
176 },
177 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178</div>
179
180<div class="method">
181 <code class="details" id="delete">delete(name, ignoreWarnings=None, x__xgafv=None)</code>
182 <pre>Deletes an app profile from an instance.
183
184Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]185 name: string, Required. The unique name of the app profile to be deleted. Values are of the form
186`projects/{project}/instances/{instance}/appProfiles/{app_profile}`. (required)
187 ignoreWarnings: boolean, Required. If true, ignore safety checks when deleting the app profile.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193Returns:
194 An object of the form:
195
196 { # A generic empty message that you can re-use to avoid defining duplicated
197 # empty messages in your APIs. A typical example is to use it as the request
198 # or the response type of an API method. For instance:
199 #
200 # service Foo {
201 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
202 # }
203 #
204 # The JSON representation for `Empty` is empty JSON object `{}`.
205 }</pre>
206</div>
207
208<div class="method">
209 <code class="details" id="get">get(name, x__xgafv=None)</code>
210 <pre>Gets information about an app profile.
211
212Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]213 name: string, Required. The unique name of the requested app profile. Values are of the form
214`projects/{project}/instances/{instance}/appProfiles/{app_profile}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 x__xgafv: string, V1 error format.
216 Allowed values
217 1 - v1 error format
218 2 - v2 error format
219
220Returns:
221 An object of the form:
222
223 { # A configuration object describing how Cloud Bigtable should treat traffic
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 # from a particular end user application.
225 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
226 # will fail over to the nearest cluster that is available in the event of
227 # transient errors or delays. Clusters in a region are considered
228 # equidistant. Choosing this option sacrifices read-your-writes consistency
229 # to improve availability.
230 },
231 &quot;name&quot;: &quot;A String&quot;, # (`OutputOnly`)
232 # The unique name of the app profile. Values are of the form
233 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/appProfiles/_a-zA-Z0-9*`.
234 &quot;description&quot;: &quot;A String&quot;, # Optional long form description of the use case for this AppProfile.
235 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the
236 # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
237 # fail the request if there has been a modification in the mean time. The
238 # `update_mask` of the request need not include `etag` for this protection
239 # to apply.
240 # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
241 # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
242 # details.
243 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
244 # This option preserves read-your-writes consistency but does not improve
245 # availability.
246 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
247 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
248 # allowed by this app profile. It is unsafe to send these requests to
249 # the same table/row/column in multiple clusters.
250 },
251 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252</div>
253
254<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]255 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 <pre>Lists information about app profiles in an instance.
257
258Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]259 parent: string, Required. The unique name of the instance for which a list of app profiles is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]260requested. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]261`projects/{project}/instances/{instance}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]262Use `{instance} = &#x27;-&#x27;` to list AppProfiles for all Instances in a project,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263e.g., `projects/myproject/instances/-`. (required)
264 pageToken: string, The value of `next_page_token` returned by a previous call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 pageSize: integer, Maximum number of results per page.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]266
267A page_size of zero lets the server choose the number of items to return.
268A page_size which is strictly positive will return at most that many items.
269A negative page_size will cause an error.
270
271Following the first request, subsequent paginated calls are not required
272to pass a page_size. If a page_size is set in subsequent calls, it must
273match the page_size given in the first request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]274 x__xgafv: string, V1 error format.
275 Allowed values
276 1 - v1 error format
277 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278
279Returns:
280 An object of the form:
281
282 { # Response message for BigtableInstanceAdmin.ListAppProfiles.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]283 &quot;nextPageToken&quot;: &quot;A String&quot;, # Set if not all app profiles could be returned in a single response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 # Pass this value to `page_token` in another request to get the next
285 # page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]286 &quot;failedLocations&quot;: [ # Locations from which AppProfile information could not be retrieved,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]287 # due to an outage or some other transient condition.
288 # AppProfiles from these locations may be missing from `app_profiles`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 # Values are of the form `projects/&lt;project&gt;/locations/&lt;zone_id&gt;`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]290 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]292 &quot;appProfiles&quot;: [ # The list of requested app profiles.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 { # A configuration object describing how Cloud Bigtable should treat traffic
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]294 # from a particular end user application.
295 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
296 # will fail over to the nearest cluster that is available in the event of
297 # transient errors or delays. Clusters in a region are considered
298 # equidistant. Choosing this option sacrifices read-your-writes consistency
299 # to improve availability.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]301 &quot;name&quot;: &quot;A String&quot;, # (`OutputOnly`)
302 # The unique name of the app profile. Values are of the form
303 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/appProfiles/_a-zA-Z0-9*`.
304 &quot;description&quot;: &quot;A String&quot;, # Optional long form description of the use case for this AppProfile.
305 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the
306 # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
307 # fail the request if there has been a modification in the mean time. The
308 # `update_mask` of the request need not include `etag` for this protection
309 # to apply.
310 # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
311 # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
312 # details.
313 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
314 # This option preserves read-your-writes consistency but does not improve
315 # availability.
316 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
317 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
318 # allowed by this app profile. It is unsafe to send these requests to
319 # the same table/row/column in multiple clusters.
320 },
321 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]322 ],
323 }</pre>
324</div>
325
326<div class="method">
327 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
328 <pre>Retrieves the next page of results.
329
330Args:
331 previous_request: The request for the previous page. (required)
332 previous_response: The response from the request for the previous page. (required)
333
334Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]335 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]336 page. Returns None if there are no more items in the collection.
337 </pre>
338</div>
339
340<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]341 <code class="details" id="patch">patch(name, body=None, updateMask=None, ignoreWarnings=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]342 <pre>Updates an app profile within an instance.
343
344Args:
345 name: string, (`OutputOnly`)
346The unique name of the app profile. Values are of the form
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]347`projects/&lt;project&gt;/instances/&lt;instance&gt;/appProfiles/_a-zA-Z0-9*`. (required)
348 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 The object takes the form of:
350
351{ # A configuration object describing how Cloud Bigtable should treat traffic
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]352 # from a particular end user application.
353 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
354 # will fail over to the nearest cluster that is available in the event of
355 # transient errors or delays. Clusters in a region are considered
356 # equidistant. Choosing this option sacrifices read-your-writes consistency
357 # to improve availability.
358 },
359 &quot;name&quot;: &quot;A String&quot;, # (`OutputOnly`)
360 # The unique name of the app profile. Values are of the form
361 # `projects/&lt;project&gt;/instances/&lt;instance&gt;/appProfiles/_a-zA-Z0-9*`.
362 &quot;description&quot;: &quot;A String&quot;, # Optional long form description of the use case for this AppProfile.
363 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the
364 # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
365 # fail the request if there has been a modification in the mean time. The
366 # `update_mask` of the request need not include `etag` for this protection
367 # to apply.
368 # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
369 # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
370 # details.
371 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
372 # This option preserves read-your-writes consistency but does not improve
373 # availability.
374 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
375 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
376 # allowed by this app profile. It is unsafe to send these requests to
377 # the same table/row/column in multiple clusters.
378 },
379}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]381 updateMask: string, Required. The subset of app profile fields which should be replaced.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]382If unset, all fields will be replaced.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]383 ignoreWarnings: boolean, If true, ignore safety checks when updating the app profile.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]384 x__xgafv: string, V1 error format.
385 Allowed values
386 1 - v1 error format
387 2 - v2 error format
388
389Returns:
390 An object of the form:
391
392 { # This resource represents a long-running operation that is the result of a
393 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]394 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
395 # contains progress information and common metadata such as create time.
396 # Some services might not provide such metadata. Any method that returns a
397 # long-running operation should document the metadata type, if any.
398 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
399 },
400 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
401 # If `true`, the operation is completed, and either `error` or `response` is
402 # available.
403 &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]404 # method returns no data on success, such as `Delete`, the response is
405 # `google.protobuf.Empty`. If the original method is standard
406 # `Get`/`Create`/`Update`, the response should be the resource. For other
407 # methods, the response should have the type `XxxResponse`, where `Xxx`
408 # is the original method name. For example, if the original method name
409 # is `TakeSnapshot()`, the inferred response type is
410 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]411 &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]412 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]413 &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]414 # originally returns it. If you use the default HTTP mapping, the
415 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]416 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]417 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]418 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
419 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]420 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]421 # You can find out more about this error model and how to work with it in the
422 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]423 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
424 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]425 # user-facing error message should be localized and sent in the
426 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]427 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]428 # message types for APIs to use.
429 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]430 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 },
432 ],
433 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]434 }</pre>
435</div>
436
437</body></html>