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