Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / cloudsearch_v1.settings.datasources.html
blob: 8991d5a67e388db09ec7eaae3d2353593e465b6b [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates a datasource. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes a datasource. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Gets a datasource. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]90 <code><a href="#list">list(pageToken=None, debugOptions_enableDebugging=None, pageSize=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Lists datasources. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<p class="firstline">Updates a datasource. **Note:** This API requires an admin account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]104<div class="method">
105 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
106 <pre>Creates a datasource. **Note:** This API requires an admin account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]107
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]109 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 The object takes the form of:
111
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112{ # 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]113 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
114 &quot;A String&quot;,
115 ],
116 &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.
117 {
118 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the customer.
119 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
120 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
121 },
122 ],
123 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
124 &quot;A String&quot;,
125 ],
126 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
127 &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.
128 &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.
129 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
130 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource The maximum length is 300 characters.
131 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132
133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
137
138Returns:
139 An object of the form:
140
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]141 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]143 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]144 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &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]148 },
149 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]151 &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}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]152 &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.
153 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
154 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]155 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]156 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
158 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]159 }</pre>
160</div>
161
162<div class="method">
163 <code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]164 <pre>Deletes a datasource. **Note:** This API requires an admin account to execute.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]165
166Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]167 name: string, Name of the datasource. Format: datasources/{source_id}. (required)
168 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]169 x__xgafv: string, V1 error format.
170 Allowed values
171 1 - v1 error format
172 2 - v2 error format
173
174Returns:
175 An object of the form:
176
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]177 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]178 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]179 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]180 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]181 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]182 {
183 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
184 },
185 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]186 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]187 &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}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]188 &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.
189 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
190 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]191 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]192 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
193 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
194 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]195 }</pre>
196</div>
197
198<div class="method">
199 <code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]200 <pre>Gets a datasource. **Note:** This API requires an admin account to execute.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]201
202Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]203 name: string, Name of the datasource resource. Format: datasources/{source_id}. (required)
204 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210Returns:
211 An object of the form:
212
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]213 { # 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]214 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
215 &quot;A String&quot;,
216 ],
217 &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.
218 {
219 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the customer.
220 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
221 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
222 },
223 ],
224 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
225 &quot;A String&quot;,
226 ],
227 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
228 &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.
229 &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.
230 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
231 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource The maximum length is 300 characters.
232 }</pre>
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]233</div>
234
235<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]236 <code class="details" id="list">list(pageToken=None, debugOptions_enableDebugging=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]237 <pre>Lists datasources. **Note:** This API requires an admin account to execute.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]238
239Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]240 pageToken: string, Starting index of the results.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]241 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]242 pageSize: integer, Maximum number of datasources to fetch in a request. The max value is 100. The default value is 10
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]243 x__xgafv: string, V1 error format.
244 Allowed values
245 1 - v1 error format
246 2 - v2 error format
247
248Returns:
249 An object of the form:
250
251 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]252 &quot;sources&quot;: [
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]253 { # 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]254 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
255 &quot;A String&quot;,
256 ],
257 &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.
258 {
259 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the customer.
260 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
261 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
262 },
263 ],
264 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
265 &quot;A String&quot;,
266 ],
267 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
268 &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.
269 &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.
270 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
271 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource The maximum length is 300 characters.
272 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]273 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]274 &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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]275 }</pre>
276</div>
277
278<div class="method">
279 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
280 <pre>Retrieves the next page of results.
281
282Args:
283 previous_request: The request for the previous page. (required)
284 previous_response: The response from the request for the previous page. (required)
285
286Returns:
287 A request object that you can call &#x27;execute()&#x27; on to request the next
288 page. Returns None if there are no more items in the collection.
289 </pre>
290</div>
291
292<div class="method">
293 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]294 <pre>Updates a datasource. **Note:** This API requires an admin account to execute.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]295
296Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]297 name: string, Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]298 body: object, The request body.
299 The object takes the form of:
300
301{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]302 &quot;debugOptions&quot;: { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
303 &quot;enableDebugging&quot;: True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
304 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]305 &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.
306 &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
307 &quot;A String&quot;,
308 ],
309 &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.
310 {
311 &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the customer.
312 &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
313 &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
314 },
315 ],
316 &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
317 &quot;A String&quot;,
318 ],
319 &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
320 &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.
321 &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.
322 &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
323 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource The maximum length is 300 characters.
324 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]325 }
326
327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
331
332Returns:
333 An object of the form:
334
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]335 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]336 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]337 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]338 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]339 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]340 {
341 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
342 },
343 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]344 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]345 &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}`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]346 &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.
347 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
348 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]349 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]350 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
351 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
352 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 }</pre>
354</div>
355
356</body></html>