Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / bigtableadmin_v2.projects.instances.appProfiles.html
blob: fd0cca0a668802bb765f2929278cdec1edf091c3 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <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]82<p class="firstline">Creates an app profile within an instance.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, ignoreWarnings=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes an app profile from an instance.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets information about an app profile.</p>
89<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]90 <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]91<p class="firstline">Lists information about app profiles in an instance.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]96 <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]97<p class="firstline">Updates an app profile within an instance.</p>
98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 <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]106 <pre>Creates an app profile within an instance.
107
108Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]109 parent: string, Required. The unique name of the instance in which to create the new app profile. Values are of the form `projects/{project}/instances/{instance}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]110 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 The object takes the form of:
112
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]113{ # A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
114 &quot;description&quot;: &quot;A String&quot;, # Long form description of the use case for this AppProfile.
115 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.
116 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy.
117 },
118 &quot;name&quot;: &quot;A String&quot;, # The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.
119 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability. # Use a single-cluster routing policy.
120 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]121 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
122 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]123 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]125 ignoreWarnings: boolean, If true, ignore safety checks when creating the app profile.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]126 appProfileId: string, Required. The ID to be used when referring to the new app profile within its instance, e.g., just `myprofile` rather than `projects/myproject/instances/myinstance/appProfiles/myprofile`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132Returns:
133 An object of the form:
134
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]135 { # A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
136 &quot;description&quot;: &quot;A String&quot;, # Long form description of the use case for this AppProfile.
137 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.
138 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy.
139 },
140 &quot;name&quot;: &quot;A String&quot;, # The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.
141 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability. # Use a single-cluster routing policy.
142 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]143 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
144 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]145 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146</div>
147
148<div class="method">
149 <code class="details" id="delete">delete(name, ignoreWarnings=None, x__xgafv=None)</code>
150 <pre>Deletes an app profile from an instance.
151
152Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]153 name: string, Required. The unique name of the app profile to be deleted. Values are of the form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]154 ignoreWarnings: boolean, Required. If true, ignore safety checks when deleting the app profile.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 x__xgafv: string, V1 error format.
156 Allowed values
157 1 - v1 error format
158 2 - v2 error format
159
160Returns:
161 An object of the form:
162
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]163 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="get">get(name, x__xgafv=None)</code>
169 <pre>Gets information about an app profile.
170
171Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]172 name: string, Required. The unique name of the requested app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 x__xgafv: string, V1 error format.
174 Allowed values
175 1 - v1 error format
176 2 - v2 error format
177
178Returns:
179 An object of the form:
180
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]181 { # A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
182 &quot;description&quot;: &quot;A String&quot;, # Long form description of the use case for this AppProfile.
183 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.
184 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy.
185 },
186 &quot;name&quot;: &quot;A String&quot;, # The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.
187 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability. # Use a single-cluster routing policy.
188 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]189 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
190 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]191 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192</div>
193
194<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195 <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]196 <pre>Lists information about app profiles in an instance.
197
198Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]199 parent: string, Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form `projects/{project}/instances/{instance}`. Use `{instance} = &#x27;-&#x27;` to list AppProfiles for all Instances in a project, e.g., `projects/myproject/instances/-`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200 pageToken: string, The value of `next_page_token` returned by a previous call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]201 pageSize: integer, Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]202 x__xgafv: string, V1 error format.
203 Allowed values
204 1 - v1 error format
205 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206
207Returns:
208 An object of the form:
209
210 { # Response message for BigtableInstanceAdmin.ListAppProfiles.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]211 &quot;failedLocations&quot;: [ # Locations from which AppProfile information could not be retrieved, due to an outage or some other transient condition. AppProfiles from these locations may be missing from `app_profiles`. Values are of the form `projects//locations/`
212 &quot;A String&quot;,
213 ],
214 &quot;nextPageToken&quot;: &quot;A String&quot;, # Set if not all app profiles could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]215 &quot;appProfiles&quot;: [ # The list of requested app profiles.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]216 { # A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
217 &quot;description&quot;: &quot;A String&quot;, # Long form description of the use case for this AppProfile.
218 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.
219 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy.
220 },
221 &quot;name&quot;: &quot;A String&quot;, # The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.
222 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability. # Use a single-cluster routing policy.
223 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]224 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
225 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 },
227 ],
228 }</pre>
229</div>
230
231<div class="method">
232 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
233 <pre>Retrieves the next page of results.
234
235Args:
236 previous_request: The request for the previous page. (required)
237 previous_response: The response from the request for the previous page. (required)
238
239Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 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]241 page. Returns None if there are no more items in the collection.
242 </pre>
243</div>
244
245<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]246 <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]247 <pre>Updates an app profile within an instance.
248
249Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]250 name: string, The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]251 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 The object takes the form of:
253
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]254{ # A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
255 &quot;description&quot;: &quot;A String&quot;, # Long form description of the use case for this AppProfile.
256 &quot;etag&quot;: &quot;A String&quot;, # Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details.
257 &quot;multiClusterRoutingUseAny&quot;: { # Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. # Use a multi-cluster routing policy.
258 },
259 &quot;name&quot;: &quot;A String&quot;, # The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.
260 &quot;singleClusterRouting&quot;: { # Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability. # Use a single-cluster routing policy.
261 &quot;allowTransactionalWrites&quot;: True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]262 &quot;clusterId&quot;: &quot;A String&quot;, # The cluster to which read/write requests should be routed.
263 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]264 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]266 ignoreWarnings: boolean, If true, ignore safety checks when updating the app profile.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]267 updateMask: string, Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]268 x__xgafv: string, V1 error format.
269 Allowed values
270 1 - v1 error format
271 2 - v2 error format
272
273Returns:
274 An object of the form:
275
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]276 { # This resource represents a long-running operation that is the result of a network API call.
277 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
278 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
279 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
280 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]281 {
282 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
283 },
284 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]285 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]286 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
287 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]288 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]289 &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]290 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]291 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
292 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
293 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294 }</pre>
295</div>
296
297</body></html>