Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / cloudsearch_v1.settings.datasources.html
blob: 54a81172ea528b58af3990d616cbd591386a0472 [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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]87 <code><a href="#list">list(pageSize=None, pageToken=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 Kimd059ad82020-07-22 17:02:09 -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;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
110 # Format: datasources/{source_id}.
111 # &lt;br /&gt;The name is ignored when creating a datasource.
112 &quot;disableModifications&quot;: True or False, # If true, Indexing API rejects any modification calls to this datasource
113 # such as create, update, and delete.
114 # Disabling this does not imply halting process of previously
115 # accepted data.
116 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
117 &quot;A String&quot;,
118 ],
119 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
120 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the
121 # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
122 # queries like *source:&amp;lt;value&amp;gt;* will only return results for this
123 # source. The value must be unique across all datasources. The value must
124 # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
125 # with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive,
126 # groups, sites, calendar, hangouts, gplus, keep, people, teams.
127 # Its maximum length is 32 characters.
128 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items
129 # within the datasource are restricted to the union of users and groups
130 # included in this field. Note that, this does not ensure access to a
131 # specific item, as users need to have ACL permissions on the contained
132 # items. This ensures a high level access on the entire datasource, and
133 # that the individual items are not shared outside this visibility.
134 {
135 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
136 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
137 # customer.
138 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
139 },
140 ],
141 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
142 # schema.
143 &quot;A String&quot;,
144 ],
145 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
146 # The maximum length is 300 characters.
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;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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]169 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
170 # contains progress information and common metadata such as create time.
171 # Some services might not provide such metadata. Any method that returns a
172 # long-running operation should document the metadata type, if any.
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
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;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]191 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]193 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
194 # originally returns it. If you use the default HTTP mapping, the
195 # `name` should be a resource name ending with `operations/{unique_id}`.
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 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]233 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
234 # contains progress information and common metadata such as create time.
235 # Some services might not provide such metadata. Any method that returns a
236 # long-running operation should document the metadata type, if any.
237 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
238 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -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.
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).
246 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
247 # message types for APIs to use.
248 {
249 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
250 },
251 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]252 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]255 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]256 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]257 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
258 # originally returns it. If you use the default HTTP mapping, the
259 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -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;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
289 # Format: datasources/{source_id}.
290 # &lt;br /&gt;The name is ignored when creating a datasource.
291 &quot;disableModifications&quot;: 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 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
296 &quot;A String&quot;,
297 ],
298 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
299 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the
300 # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
301 # queries like *source:&amp;lt;value&amp;gt;* will only return results for this
302 # source. The value must be unique across all datasources. The value must
303 # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
304 # with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive,
305 # groups, sites, calendar, hangouts, gplus, keep, people, teams.
306 # Its maximum length is 32 characters.
307 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items
308 # within the datasource are restricted to the union of users and groups
309 # included in this field. Note that, this does not ensure access to a
310 # specific item, as users need to have ACL permissions on the contained
311 # items. This ensures a high level access on the entire datasource, and
312 # that the individual items are not shared outside this visibility.
313 {
314 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
315 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
316 # customer.
317 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
318 },
319 ],
320 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
321 # schema.
322 &quot;A String&quot;,
323 ],
324 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
325 # The maximum length is 300 characters.
326 }</pre>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]327</div>
328
329<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]330 <code class="details" id="list">list(pageSize=None, pageToken=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]331 <pre>Lists datasources.
332
333**Note:** This API requires an admin account to execute.
334
335Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]336 pageSize: integer, Maximum number of datasources to fetch in a request.
337The max value is 100.
338&lt;br /&gt;The default value is 10
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]339 pageToken: string, Starting index of the results.
340 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
341Otherwise, ignore this field.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -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 {
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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]355 # All items must belong to a datasource. This is the prerequisite before
356 # items can be indexed into Cloud Search.
357 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
358 # Format: datasources/{source_id}.
359 # &lt;br /&gt;The name is ignored when creating a datasource.
360 &quot;disableModifications&quot;: True or False, # If true, Indexing API rejects any modification calls to this datasource
361 # such as create, update, and delete.
362 # Disabling this does not imply halting process of previously
363 # accepted data.
364 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
365 &quot;A String&quot;,
366 ],
367 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
368 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the
369 # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
370 # queries like *source:&amp;lt;value&amp;gt;* will only return results for this
371 # source. The value must be unique across all datasources. The value must
372 # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
373 # with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive,
374 # groups, sites, calendar, hangouts, gplus, keep, people, teams.
375 # Its maximum length is 32 characters.
376 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items
377 # within the datasource are restricted to the union of users and groups
378 # included in this field. Note that, this does not ensure access to a
379 # specific item, as users need to have ACL permissions on the contained
380 # items. This ensures a high level access on the entire datasource, and
381 # that the individual items are not shared outside this visibility.
382 {
383 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
384 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
385 # customer.
386 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
387 },
388 ],
389 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
390 # schema.
391 &quot;A String&quot;,
392 ],
393 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
394 # The maximum length is 300 characters.
395 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]429 # All items must belong to a datasource. This is the prerequisite before
430 # items can be indexed into Cloud Search.
431 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
432 # Format: datasources/{source_id}.
433 # &lt;br /&gt;The name is ignored when creating a datasource.
434 &quot;disableModifications&quot;: True or False, # If true, Indexing API rejects any modification calls to this datasource
435 # such as create, update, and delete.
436 # Disabling this does not imply halting process of previously
437 # accepted data.
438 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
439 &quot;A String&quot;,
440 ],
441 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
442 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the
443 # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
444 # queries like *source:&amp;lt;value&amp;gt;* will only return results for this
445 # source. The value must be unique across all datasources. The value must
446 # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
447 # with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive,
448 # groups, sites, calendar, hangouts, gplus, keep, people, teams.
449 # Its maximum length is 32 characters.
450 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items
451 # within the datasource are restricted to the union of users and groups
452 # included in this field. Note that, this does not ensure access to a
453 # specific item, as users need to have ACL permissions on the contained
454 # items. This ensures a high level access on the entire datasource, and
455 # that the individual items are not shared outside this visibility.
456 {
457 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
458 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
459 # customer.
460 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
461 },
462 ],
463 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
464 # schema.
465 &quot;A String&quot;,
466 ],
467 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
468 # The maximum length is 300 characters.
469 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]496 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
497 # contains progress information and common metadata such as create time.
498 # Some services might not provide such metadata. Any method that returns a
499 # long-running operation should document the metadata type, if any.
500 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
501 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -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.
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).
509 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
510 # message types for APIs to use.
511 {
512 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
513 },
514 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]515 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]518 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]519 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]520 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
521 # originally returns it. If you use the default HTTP mapping, the
522 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]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>