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