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