Debian Codegraph @

docs/dyn/cloudsearch_v1.settings.datasources.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a datasource. **Note:** This API requires an admin account to execute.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a datasource. **Note:** This API requires an admin account to execute.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets a datasource. **Note:** This API requires an admin account to execute.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(debugOptions_enableDebugging=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists datasources. **Note:** This API requires an admin account to execute.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, debugOptions_enableDebugging=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates a datasource. **Note:** This API requires an admin account to execute.</p>
98 <p class="toc_element">
99 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Updates a datasource. **Note:** This API requires an admin account to execute.</p>
101 <h3>Method Details</h3>
102 <div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105 </div>
106
107 <div class="method">
108 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
109 <pre>Creates a datasource. **Note:** This API requires an admin account to execute.
110
111 Args:
112 body: object, The request body.
113 The object takes the form of:
114
115 { # Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
116 &quot;disableModifications&quot;: True or False, # If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
117 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
118 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource The maximum length is 300 characters.
119 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
120 &quot;A String&quot;,
121 ],
122 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
123 {
124 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the Google Workspace domain of the customer.
125 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace group name.
126 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace user account.
127 },
128 ],
129 &quot;name&quot;: &quot;A String&quot;, # The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
130 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
131 &quot;A String&quot;,
132 ],
133 &quot;returnThumbnailUrls&quot;: True or False, # Can a user request to get thumbnail URI for Items indexed in this data source.
134 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the &#x27;source&#x27; operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
135 }
136
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142 Returns:
143 An object of the form:
144
145 { # This resource represents a long-running operation that is the result of a network API call.
146 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
147 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
148 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
149 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
150 {
151 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
152 },
153 ],
154 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
155 },
156 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
158 },
159 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
160 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
161 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
162 },
163 }</pre>
164 </div>
165
166 <div class="method">
167 <code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
168 <pre>Deletes a datasource. **Note:** This API requires an admin account to execute.
169
170 Args:
171 name: string, The name of the datasource. Format: datasources/{source_id}. (required)
172 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
173 x__xgafv: string, V1 error format.
174 Allowed values
175 1 - v1 error format
176 2 - v2 error format
177
178 Returns:
179 An object of the form:
180
181 { # This resource represents a long-running operation that is the result of a network API call.
182 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
183 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
184 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
185 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
186 {
187 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
188 },
189 ],
190 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
191 },
192 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
193 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
194 },
195 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
196 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
197 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
198 },
199 }</pre>
200 </div>
201
202 <div class="method">
203 <code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
204 <pre>Gets a datasource. **Note:** This API requires an admin account to execute.
205
206 Args:
207 name: string, The name of the datasource resource. Format: datasources/{source_id}. (required)
208 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
213
214 Returns:
215 An object of the form:
216
217 { # Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
218 &quot;disableModifications&quot;: True or False, # If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
219 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
220 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource The maximum length is 300 characters.
221 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
222 &quot;A String&quot;,
223 ],
224 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
225 {
226 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the Google Workspace domain of the customer.
227 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace group name.
228 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace user account.
229 },
230 ],
231 &quot;name&quot;: &quot;A String&quot;, # The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
232 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
233 &quot;A String&quot;,
234 ],
235 &quot;returnThumbnailUrls&quot;: True or False, # Can a user request to get thumbnail URI for Items indexed in this data source.
236 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the &#x27;source&#x27; operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
237 }</pre>
238 </div>
239
240 <div class="method">
241 <code class="details" id="list">list(debugOptions_enableDebugging=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
242 <pre>Lists datasources. **Note:** This API requires an admin account to execute.
243
244 Args:
245 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
246 pageSize: integer, Maximum number of datasources to fetch in a request. The max value is 1000. The default value is 1000.
247 pageToken: string, Starting index of the results.
248 x__xgafv: string, V1 error format.
249 Allowed values
250 1 - v1 error format
251 2 - v2 error format
252
253 Returns:
254 An object of the form:
255
256 {
257 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
258 &quot;sources&quot;: [
259 { # Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
260 &quot;disableModifications&quot;: True or False, # If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
261 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
262 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource The maximum length is 300 characters.
263 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
264 &quot;A String&quot;,
265 ],
266 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
267 {
268 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the Google Workspace domain of the customer.
269 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace group name.
270 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace user account.
271 },
272 ],
273 &quot;name&quot;: &quot;A String&quot;, # The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
274 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
275 &quot;A String&quot;,
276 ],
277 &quot;returnThumbnailUrls&quot;: True or False, # Can a user request to get thumbnail URI for Items indexed in this data source.
278 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the &#x27;source&#x27; operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
279 },
280 ],
281 }</pre>
282 </div>
283
284 <div class="method">
285 <code class="details" id="list_next">list_next()</code>
286 <pre>Retrieves the next page of results.
287
288 Args:
289 previous_request: The request for the previous page. (required)
290 previous_response: The response from the request for the previous page. (required)
291
292 Returns:
293 A request object that you can call &#x27;execute()&#x27; on to request the next
294 page. Returns None if there are no more items in the collection.
295 </pre>
296 </div>
297
298 <div class="method">
299 <code class="details" id="patch">patch(name, body=None, debugOptions_enableDebugging=None, updateMask=None, x__xgafv=None)</code>
300 <pre>Updates a datasource. **Note:** This API requires an admin account to execute.
301
302 Args:
303 name: string, The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource. (required)
304 body: object, The request body.
305 The object takes the form of:
306
307 { # Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
308 &quot;disableModifications&quot;: True or False, # If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
309 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
310 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource The maximum length is 300 characters.
311 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
312 &quot;A String&quot;,
313 ],
314 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
315 {
316 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the Google Workspace domain of the customer.
317 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace group name.
318 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace user account.
319 },
320 ],
321 &quot;name&quot;: &quot;A String&quot;, # The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
322 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
323 &quot;A String&quot;,
324 ],
325 &quot;returnThumbnailUrls&quot;: True or False, # Can a user request to get thumbnail URI for Items indexed in this data source.
326 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the &#x27;source&#x27; operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
327 }
328
329 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
330 updateMask: string, Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don&#x27;t specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.
331 x__xgafv: string, V1 error format.
332 Allowed values
333 1 - v1 error format
334 2 - v2 error format
335
336 Returns:
337 An object of the form:
338
339 { # This resource represents a long-running operation that is the result of a network API call.
340 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
341 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
342 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
343 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
344 {
345 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
346 },
347 ],
348 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
349 },
350 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
351 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
352 },
353 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
354 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
355 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
356 },
357 }</pre>
358 </div>
359
360 <div class="method">
361 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
362 <pre>Updates a datasource. **Note:** This API requires an admin account to execute.
363
364 Args:
365 name: string, The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource. (required)
366 body: object, The request body.
367 The object takes the form of:
368
369 {
370 &quot;debugOptions&quot;: { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
371 &quot;enableDebugging&quot;: True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
372 },
373 &quot;source&quot;: { # Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
374 &quot;disableModifications&quot;: True or False, # If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
375 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
376 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource The maximum length is 300 characters.
377 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
378 &quot;A String&quot;,
379 ],
380 &quot;itemsVisibility&quot;: [ # This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
381 {
382 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the Google Workspace domain of the customer.
383 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace group name.
384 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a Google Workspace user account.
385 },
386 ],
387 &quot;name&quot;: &quot;A String&quot;, # The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
388 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
389 &quot;A String&quot;,
390 ],
391 &quot;returnThumbnailUrls&quot;: True or False, # Can a user request to get thumbnail URI for Items indexed in this data source.
392 &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the &#x27;source&#x27; operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
393 },
394 &quot;updateMask&quot;: &quot;A String&quot;, # Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don&#x27;t specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.
395 }
396
397 x__xgafv: string, V1 error format.
398 Allowed values
399 1 - v1 error format
400 2 - v2 error format
401
402 Returns:
403 An object of the form:
404
405 { # This resource represents a long-running operation that is the result of a network API call.
406 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
407 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
408 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
409 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
410 {
411 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
412 },
413 ],
414 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
415 },
416 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
417 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
418 },
419 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
420 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
421 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
422 },
423 }</pre>
424 </div>
425
426 </body></html>