Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ed7d3f9b61ac35e08a22b4995076a95451cf7c8 / . / docs / dyn / cloudsearch_v1.settings.datasources.html
blob: 14e21292169824580a5c34ca4db28c93f4453299 [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="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.settings.html">settings</a> . <a href="cloudsearch_v1.settings.datasources.html">datasources</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates a datasource.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a datasource.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a datasource.</p>
86<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]87 <code><a href="#list">list(debugOptions_enableDebugging=None, 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 datasources.</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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Updates a datasource.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <pre>Creates a datasource.
99
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100**Note:** This API requires an admin account to execute.
101
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 The object takes the form of:
105
106{ # Datasource is a logical namespace for items to be indexed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 # All items must belong to a datasource. This is the prerequisite before
108 # items can be indexed into Cloud Search.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
110 &quot;A String&quot;,
111 ],
112 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
113 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
114 # The maximum length is 300 characters.
115 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items
116 # within the datasource are restricted to the union of users and groups
117 # included in this field. Note that, this does not ensure access to a
118 # specific item, as users need to have ACL permissions on the contained
119 # items. This ensures a high level access on the entire datasource, and
120 # that the individual items are not shared outside this visibility.
121 {
122 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
123 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
124 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
125 # customer.
126 },
127 ],
128 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the
129 # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
130 # queries like *source:&amp;lt;value&amp;gt;* will only return results for this
131 # source. The value must be unique across all datasources. The value must
132 # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
133 # with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive,
134 # groups, sites, calendar, hangouts, gplus, keep, people, teams.
135 # Its maximum length is 32 characters.
136 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
137 # Format: datasources/{source_id}.
138 # &lt;br /&gt;The name is ignored when creating a datasource.
139 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
140 # schema.
141 &quot;A String&quot;,
142 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]143 &quot;disableModifications&quot;: True or False, # If true, Indexing API rejects any modification calls to this datasource
144 # such as create, update, and delete.
145 # Disabling this does not imply halting process of previously
146 # accepted data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 }
148
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154Returns:
155 An object of the form:
156
157 { # This resource represents a long-running operation that is the result of a
158 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &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]160 # method returns no data on success, such as `Delete`, the response is
161 # `google.protobuf.Empty`. If the original method is standard
162 # `Get`/`Create`/`Update`, the response should be the resource. For other
163 # methods, the response should have the type `XxxResponse`, where `Xxx`
164 # is the original method name. For example, if the original method name
165 # is `TakeSnapshot()`, the inferred response type is
166 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 &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]168 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 &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]170 # originally returns it. If you use the default HTTP mapping, the
171 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]172 &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]173 # different programming environments, including REST APIs and RPC APIs. It is
174 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
175 # three pieces of data: error code, error message, and error details.
176 #
177 # You can find out more about this error model and how to work with it in the
178 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179 &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]180 # message types for APIs to use.
181 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 &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]183 },
184 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]185 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
186 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
187 # user-facing error message should be localized and sent in the
188 # google.rpc.Status.details field, or localized by the client.
189 },
190 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
191 # contains progress information and common metadata such as create time.
192 # Some services might not provide such metadata. Any method that returns a
193 # long-running operation should document the metadata type, if any.
194 &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]195 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]196 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
197 # If `true`, the operation is completed, and either `error` or `response` is
198 # available.
199 }</pre>
200</div>
201
202<div class="method">
203 <code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
204 <pre>Deletes a datasource.
205
206**Note:** This API requires an admin account to execute.
207
208Args:
209 name: string, Name of the datasource.
210Format: datasources/{source_id}. (required)
211 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
212Otherwise, ignore this field.
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 { # This resource represents a long-running operation that is the result of a
222 # network API call.
223 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
224 # method returns no data on success, such as `Delete`, the response is
225 # `google.protobuf.Empty`. If the original method is standard
226 # `Get`/`Create`/`Update`, the response should be the resource. For other
227 # methods, the response should have the type `XxxResponse`, where `Xxx`
228 # is the original method name. For example, if the original method name
229 # is `TakeSnapshot()`, the inferred response type is
230 # `TakeSnapshotResponse`.
231 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
232 },
233 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
234 # originally returns it. If you use the default HTTP mapping, the
235 # `name` should be a resource name ending with `operations/{unique_id}`.
236 &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.
237 # different programming environments, including REST APIs and RPC APIs. It is
238 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
239 # three pieces of data: error code, error message, and error details.
240 #
241 # You can find out more about this error model and how to work with it in the
242 # [API Design Guide](https://cloud.google.com/apis/design/errors).
243 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
244 # message types for APIs to use.
245 {
246 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
247 },
248 ],
249 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
250 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
251 # user-facing error message should be localized and sent in the
252 # google.rpc.Status.details field, or localized by the client.
253 },
254 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
255 # contains progress information and common metadata such as create time.
256 # Some services might not provide such metadata. Any method that returns a
257 # long-running operation should document the metadata type, if any.
258 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
259 },
260 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
261 # If `true`, the operation is completed, and either `error` or `response` is
262 # available.
263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
268 <pre>Gets a datasource.
269
270**Note:** This API requires an admin account to execute.
271
272Args:
273 name: string, Name of the datasource resource.
274Format: datasources/{source_id}. (required)
275 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
276Otherwise, ignore this field.
277 x__xgafv: string, V1 error format.
278 Allowed values
279 1 - v1 error format
280 2 - v2 error format
281
282Returns:
283 An object of the form:
284
285 { # Datasource is a logical namespace for items to be indexed.
286 # All items must belong to a datasource. This is the prerequisite before
287 # items can be indexed into Cloud Search.
288 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
289 &quot;A String&quot;,
290 ],
291 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
292 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
293 # The maximum length is 300 characters.
294 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items
295 # within the datasource are restricted to the union of users and groups
296 # included in this field. Note that, this does not ensure access to a
297 # specific item, as users need to have ACL permissions on the contained
298 # items. This ensures a high level access on the entire datasource, and
299 # that the individual items are not shared outside this visibility.
300 {
301 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
302 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
303 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
304 # customer.
305 },
306 ],
307 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the
308 # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
309 # queries like *source:&amp;lt;value&amp;gt;* will only return results for this
310 # source. The value must be unique across all datasources. The value must
311 # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
312 # with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive,
313 # groups, sites, calendar, hangouts, gplus, keep, people, teams.
314 # Its maximum length is 32 characters.
315 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
316 # Format: datasources/{source_id}.
317 # &lt;br /&gt;The name is ignored when creating a datasource.
318 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
319 # schema.
320 &quot;A String&quot;,
321 ],
322 &quot;disableModifications&quot;: True or False, # If true, Indexing API rejects any modification calls to this datasource
323 # such as create, update, and delete.
324 # Disabling this does not imply halting process of previously
325 # accepted data.
326 }</pre>
327</div>
328
329<div class="method">
330 <code class="details" id="list">list(debugOptions_enableDebugging=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
331 <pre>Lists datasources.
332
333**Note:** This API requires an admin account to execute.
334
335Args:
336 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
337Otherwise, ignore this field.
338 pageToken: string, Starting index of the results.
339 pageSize: integer, Maximum number of datasources to fetch in a request.
340The max value is 100.
341&lt;br /&gt;The default value is 10
342 x__xgafv: string, V1 error format.
343 Allowed values
344 1 - v1 error format
345 2 - v2 error format
346
347Returns:
348 An object of the form:
349
350 {
351 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
352 # more results in the list.
353 &quot;sources&quot;: [
354 { # Datasource is a logical namespace for items to be indexed.
355 # All items must belong to a datasource. This is the prerequisite before
356 # items can be indexed into Cloud Search.
357 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
358 &quot;A String&quot;,
359 ],
360 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
361 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
362 # The maximum length is 300 characters.
363 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items
364 # within the datasource are restricted to the union of users and groups
365 # included in this field. Note that, this does not ensure access to a
366 # specific item, as users need to have ACL permissions on the contained
367 # items. This ensures a high level access on the entire datasource, and
368 # that the individual items are not shared outside this visibility.
369 {
370 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
371 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
372 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
373 # customer.
374 },
375 ],
376 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the
377 # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
378 # queries like *source:&amp;lt;value&amp;gt;* will only return results for this
379 # source. The value must be unique across all datasources. The value must
380 # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
381 # with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive,
382 # groups, sites, calendar, hangouts, gplus, keep, people, teams.
383 # Its maximum length is 32 characters.
384 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
385 # Format: datasources/{source_id}.
386 # &lt;br /&gt;The name is ignored when creating a datasource.
387 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
388 # schema.
389 &quot;A String&quot;,
390 ],
391 &quot;disableModifications&quot;: True or False, # If true, Indexing API rejects any modification calls to this datasource
392 # such as create, update, and delete.
393 # Disabling this does not imply halting process of previously
394 # accepted data.
395 },
396 ],
397 }</pre>
398</div>
399
400<div class="method">
401 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
402 <pre>Retrieves the next page of results.
403
404Args:
405 previous_request: The request for the previous page. (required)
406 previous_response: The response from the request for the previous page. (required)
407
408Returns:
409 A request object that you can call &#x27;execute()&#x27; on to request the next
410 page. Returns None if there are no more items in the collection.
411 </pre>
412</div>
413
414<div class="method">
415 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
416 <pre>Updates a datasource.
417
418**Note:** This API requires an admin account to execute.
419
420Args:
421 name: string, Name of the datasource resource.
422Format: datasources/{source_id}.
423&lt;br /&gt;The name is ignored when creating a datasource. (required)
424 body: object, The request body.
425 The object takes the form of:
426
427{
428 &quot;source&quot;: { # Datasource is a logical namespace for items to be indexed.
429 # All items must belong to a datasource. This is the prerequisite before
430 # items can be indexed into Cloud Search.
431 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
432 &quot;A String&quot;,
433 ],
434 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
435 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
436 # The maximum length is 300 characters.
437 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items
438 # within the datasource are restricted to the union of users and groups
439 # included in this field. Note that, this does not ensure access to a
440 # specific item, as users need to have ACL permissions on the contained
441 # items. This ensures a high level access on the entire datasource, and
442 # that the individual items are not shared outside this visibility.
443 {
444 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
445 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
446 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
447 # customer.
448 },
449 ],
450 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the
451 # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
452 # queries like *source:&amp;lt;value&amp;gt;* will only return results for this
453 # source. The value must be unique across all datasources. The value must
454 # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
455 # with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive,
456 # groups, sites, calendar, hangouts, gplus, keep, people, teams.
457 # Its maximum length is 32 characters.
458 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
459 # Format: datasources/{source_id}.
460 # &lt;br /&gt;The name is ignored when creating a datasource.
461 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
462 # schema.
463 &quot;A String&quot;,
464 ],
465 &quot;disableModifications&quot;: True or False, # If true, Indexing API rejects any modification calls to this datasource
466 # such as create, update, and delete.
467 # Disabling this does not imply halting process of previously
468 # accepted data.
469 },
470 &quot;debugOptions&quot;: { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
471 &quot;enableDebugging&quot;: True or False, # If you are asked by Google to help with debugging, set this field.
472 # Otherwise, ignore this field.
473 },
474 }
475
476 x__xgafv: string, V1 error format.
477 Allowed values
478 1 - v1 error format
479 2 - v2 error format
480
481Returns:
482 An object of the form:
483
484 { # This resource represents a long-running operation that is the result of a
485 # network API call.
486 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
487 # method returns no data on success, such as `Delete`, the response is
488 # `google.protobuf.Empty`. If the original method is standard
489 # `Get`/`Create`/`Update`, the response should be the resource. For other
490 # methods, the response should have the type `XxxResponse`, where `Xxx`
491 # is the original method name. For example, if the original method name
492 # is `TakeSnapshot()`, the inferred response type is
493 # `TakeSnapshotResponse`.
494 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
495 },
496 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
497 # originally returns it. If you use the default HTTP mapping, the
498 # `name` should be a resource name ending with `operations/{unique_id}`.
499 &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.
500 # different programming environments, including REST APIs and RPC APIs. It is
501 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
502 # three pieces of data: error code, error message, and error details.
503 #
504 # You can find out more about this error model and how to work with it in the
505 # [API Design Guide](https://cloud.google.com/apis/design/errors).
506 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
507 # message types for APIs to use.
508 {
509 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
510 },
511 ],
512 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
513 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
514 # user-facing error message should be localized and sent in the
515 # google.rpc.Status.details field, or localized by the client.
516 },
517 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
518 # contains progress information and common metadata such as create time.
519 # Some services might not provide such metadata. Any method that returns a
520 # long-running operation should document the metadata type, if any.
521 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
522 },
523 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
524 # If `true`, the operation is completed, and either `error` or `response` is
525 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]526 }</pre>
527</div>
528
529</body></html>