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