Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / cloudsearch_v1.indexing.datasources.items.html
blob: be79aa4b64f0abc918bc3ef279ff1701a446b3a9 [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.indexing.html">indexing</a> . <a href="cloudsearch_v1.indexing.datasources.html">datasources</a> . <a href="cloudsearch_v1.indexing.datasources.items.html">items</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(name, connectorName=None, version=None, mode=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes Item resource for the</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#deleteQueueItems">deleteQueueItems(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Deletes all items in a queue. This method is useful for deleting stale</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, connectorName=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets Item resource by item name.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#index">index(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Updates Item ACL, metadata, and</p>
89<p class="toc_element">
90 <code><a href="#list">list(name, pageSize=None, brief=None, connectorName=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Lists all or a subset of Item resources.</p>
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="#poll">poll(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Polls for unreserved items from the indexing queue and marks a</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#push">push(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Pushes an item onto a queue for later polling and updating.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#unreserve">unreserve(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Unreserves all items from a queue, making them all eligible to be</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code><a href="#upload">upload(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="firstline">Creates an upload session for uploading item content. For items smaller</p>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="delete">delete(name, connectorName=None, version=None, mode=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
110 <pre>Deletes Item resource for the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111specified resource name. This API requires an admin or service account
112to execute. The service account used is the one whitelisted in the
113corresponding data source.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114
115Args:
116 name: string, Required. Name of the item to delete.
117Format: datasources/{source_id}/items/{item_id} (required)
118 connectorName: string, Name of connector making this call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]119&lt;br /&gt;Format: datasources/{source_id}/connectors/{ID}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 version: string, Required. The incremented version of the item to delete from the index.
121The indexing system stores the version from the datasource as a
122byte string and compares the Item version in the index
123to the version of the queued Item using lexical ordering.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124&lt;br /&gt;&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125Cloud Search Indexing won't delete any queued item with
126a version value that is less than or equal to
127the version of the currently indexed item.
128The maximum length for this field is 1024 bytes.
129 mode: string, Required. The RequestMode for this request.
130 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
131Otherwise, ignore this field.
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
140 { # This resource represents a long-running operation that is the result of a
141 # network API call.
142 "metadata": { # Service-specific metadata associated with the operation. It typically
143 # contains progress information and common metadata such as create time.
144 # Some services might not provide such metadata. Any method that returns a
145 # long-running operation should document the metadata type, if any.
146 "a_key": "", # Properties of the object. Contains field @type with type URL.
147 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]148 "done": True or False, # If the value is `false`, it means the operation is still in progress.
149 # If `true`, the operation is completed, and either `error` or `response` is
150 # available.
151 "response": { # The normal response of the operation in case of success. If the original
152 # method returns no data on success, such as `Delete`, the response is
153 # `google.protobuf.Empty`. If the original method is standard
154 # `Get`/`Create`/`Update`, the response should be the resource. For other
155 # methods, the response should have the type `XxxResponse`, where `Xxx`
156 # is the original method name. For example, if the original method name
157 # is `TakeSnapshot()`, the inferred response type is
158 # `TakeSnapshotResponse`.
159 "a_key": "", # Properties of the object. Contains field @type with type URL.
160 },
161 "name": "A String", # The server-assigned name, which is only unique within the same service that
162 # originally returns it. If you use the default HTTP mapping, the
163 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
165 # different programming environments, including REST APIs and RPC APIs. It is
166 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
167 # three pieces of data: error code, error message, and error details.
168 #
169 # You can find out more about this error model and how to work with it in the
170 # [API Design Guide](https://cloud.google.com/apis/design/errors).
171 "message": "A String", # A developer-facing error message, which should be in English. Any
172 # user-facing error message should be localized and sent in the
173 # google.rpc.Status.details field, or localized by the client.
174 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
175 "details": [ # A list of messages that carry the error details. There is a common set of
176 # message types for APIs to use.
177 {
178 "a_key": "", # Properties of the object. Contains field @type with type URL.
179 },
180 ],
181 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182 }</pre>
183</div>
184
185<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]186 <code class="details" id="deleteQueueItems">deleteQueueItems(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187 <pre>Deletes all items in a queue. This method is useful for deleting stale
188items.
189
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]190This API requires an admin or service account to execute. The service
191account used is the one whitelisted in the corresponding data source.
192
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193Args:
194 name: string, Name of the Data Source to delete items in a queue.
195Format: datasources/{source_id} (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]196 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 The object takes the form of:
198
199{
200 "queue": "A String", # Name of a queue to delete items from.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
202 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
203 # Otherwise, ignore this field.
204 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 "connectorName": "A String", # Name of connector making this call.
206 # &lt;br /&gt;Format: datasources/{source_id}/connectors/{ID}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 }
208
209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
213
214Returns:
215 An object of the form:
216
217 { # This resource represents a long-running operation that is the result of a
218 # network API call.
219 "metadata": { # Service-specific metadata associated with the operation. It typically
220 # contains progress information and common metadata such as create time.
221 # Some services might not provide such metadata. Any method that returns a
222 # long-running operation should document the metadata type, if any.
223 "a_key": "", # Properties of the object. Contains field @type with type URL.
224 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 "done": True or False, # If the value is `false`, it means the operation is still in progress.
226 # If `true`, the operation is completed, and either `error` or `response` is
227 # available.
228 "response": { # The normal response of the operation in case of success. If the original
229 # method returns no data on success, such as `Delete`, the response is
230 # `google.protobuf.Empty`. If the original method is standard
231 # `Get`/`Create`/`Update`, the response should be the resource. For other
232 # methods, the response should have the type `XxxResponse`, where `Xxx`
233 # is the original method name. For example, if the original method name
234 # is `TakeSnapshot()`, the inferred response type is
235 # `TakeSnapshotResponse`.
236 "a_key": "", # Properties of the object. Contains field @type with type URL.
237 },
238 "name": "A String", # The server-assigned name, which is only unique within the same service that
239 # originally returns it. If you use the default HTTP mapping, the
240 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
242 # different programming environments, including REST APIs and RPC APIs. It is
243 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
244 # three pieces of data: error code, error message, and error details.
245 #
246 # You can find out more about this error model and how to work with it in the
247 # [API Design Guide](https://cloud.google.com/apis/design/errors).
248 "message": "A String", # A developer-facing error message, which should be in English. Any
249 # user-facing error message should be localized and sent in the
250 # google.rpc.Status.details field, or localized by the client.
251 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
252 "details": [ # A list of messages that carry the error details. There is a common set of
253 # message types for APIs to use.
254 {
255 "a_key": "", # Properties of the object. Contains field @type with type URL.
256 },
257 ],
258 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]259 }</pre>
260</div>
261
262<div class="method">
263 <code class="details" id="get">get(name, connectorName=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
264 <pre>Gets Item resource by item name.
265
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]266This API requires an admin or service account to execute. The service
267account used is the one whitelisted in the corresponding data source.
268
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269Args:
270 name: string, Name of the item to get info.
271Format: datasources/{source_id}/items/{item_id} (required)
272 connectorName: string, Name of connector making this call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]273&lt;br /&gt;Format: datasources/{source_id}/connectors/{ID}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]274 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
275Otherwise, ignore this field.
276 x__xgafv: string, V1 error format.
277 Allowed values
278 1 - v1 error format
279 2 - v2 error format
280
281Returns:
282 An object of the form:
283
284 { # Represents a single object that is an item in the search index, such as a
285 # file, folder, or a database record.
286 "status": { # This contains item's status and any errors. # Status of the item.
287 # Output only field.
288 "processingErrors": [ # Error details in case the item is in ERROR state.
289 {
290 "code": "A String", # Error code indicating the nature of the error.
291 "errorMessage": "A String", # Description of the error.
292 "fieldViolations": [ # In case the item fields are invalid, this field contains the details
293 # about the validation errors.
294 {
295 "field": "A String", # Path of field with violation.
296 "description": "A String", # Description of the error.
297 },
298 ],
299 },
300 ],
301 "repositoryErrors": [ # Repository error reported by connector.
302 { # Errors when the connector is communicating to the source repository.
303 "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
304 "errorMessage": "A String", # Message that describes the error. The maximum allowable length
305 # of the message is 8192 characters.
306 "type": "A String", # Type of error.
307 },
308 ],
309 "code": "A String", # Status code.
310 },
311 "queue": "A String", # Queue this item belongs to.
312 # The maximum length is 100 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]313 "itemType": "A String", # Type for this item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314 "name": "A String", # Name of the Item. Format:
315 # datasources/{source_id}/items/{item_id}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]316 # &lt;br /&gt;This is a required field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317 # The maximum length is 1536 characters.
318 "acl": { # Access control list information for the item. For more information see # Access control list for this item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]319 # [Map ACLs](/cloud-search/docs/guides/acls).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
321 # parent. This should always be set in tandem with the
322 # inheritAclFrom
323 # field. Also, when the
324 # inheritAclFrom field
325 # is set, this field should be set to a valid AclInheritanceType.
326 "readers": [ # List of principals who are allowed to see the item in search results.
327 # Optional if inheriting permissions from another item or if the item
328 # is not intended to be visible, such as
329 # virtual
330 # containers.
331 # The maximum number of elements is 1000.
332 { # Reference to a user, group, or domain.
333 "userResourceName": "A String", # This principal is a user identified using an external identity.
334 # The name field must specify the user resource name with this format:
335 # identitysources/{source_id}/users/{ID}
336 "groupResourceName": "A String", # This principal is a group identified using an external identity.
337 # The name field must specify the group resource name with this format:
338 # identitysources/{source_id}/groups/{ID}
339 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
340 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
341 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
342 # customer.
343 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
344 },
345 },
346 ],
347 "deniedReaders": [ # List of principals who are explicitly denied access to the item in search
348 # results. While principals are denied access by default, use denied readers
349 # to handle exceptions and override the list allowed readers.
350 # The maximum number of elements is 100.
351 { # Reference to a user, group, or domain.
352 "userResourceName": "A String", # This principal is a user identified using an external identity.
353 # The name field must specify the user resource name with this format:
354 # identitysources/{source_id}/users/{ID}
355 "groupResourceName": "A String", # This principal is a group identified using an external identity.
356 # The name field must specify the group resource name with this format:
357 # identitysources/{source_id}/groups/{ID}
358 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
359 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
360 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
361 # customer.
362 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
363 },
364 },
365 ],
366 "owners": [ # Optional. List of owners for the item. This field has no bearing on
367 # document access permissions. It does, however, offer
368 # a slight ranking boosts items where the querying user is an owner.
369 # The maximum number of elements is 5.
370 { # Reference to a user, group, or domain.
371 "userResourceName": "A String", # This principal is a user identified using an external identity.
372 # The name field must specify the user resource name with this format:
373 # identitysources/{source_id}/users/{ID}
374 "groupResourceName": "A String", # This principal is a group identified using an external identity.
375 # The name field must specify the group resource name with this format:
376 # identitysources/{source_id}/groups/{ID}
377 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
378 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
379 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
380 # customer.
381 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
382 },
383 },
384 ],
385 "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
386 # Note: ACL inheritance *only* provides access permissions
387 # to child items and does not define structural relationships, nor does it
388 # provide convenient ways to delete large groups of items.
389 # Deleting an ACL parent from the index only alters the access permissions of
390 # child items that reference the parent in the
391 # inheritAclFrom
392 # field. The item is still in the index, but may not
393 # visible in search results. By contrast, deletion of a container item
394 # also deletes all items that reference the container via the
395 # containerName
396 # field.
397 # The maximum length for this field is 1536 characters.
398 },
399 "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
400 "contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
401 # This reference is created via upload
402 # method.
403 # Updating of item content may refer to this uploaded content via
404 # contentDataRef.
405 "name": "A String", # Name of the content reference.
406 # The maximum length is 2048 characters.
407 },
408 "contentFormat": "A String",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]409 "inlineContent": "A String", # Content that is supplied inlined within the update method.
410 # The maximum length is 102400 bytes (100 KiB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]411 "hash": "A String", # Hashing info calculated and provided by the API client for content.
412 # Can be used with the items.push method to calculate modified state.
413 # The maximum length is 2048 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 },
415 "version": "A String", # Required. The indexing system stores the version from the datasource as a
416 # byte string and compares the Item version in the index
417 # to the version of the queued Item using lexical ordering.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418 # &lt;br /&gt;&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]419 # Cloud Search Indexing won't index or delete any queued item with
420 # a version value that is less than or equal to the version of the
421 # currently indexed item.
422 # The maximum length for this field is 1024 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]423 "structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
424 # object definition in the schema for the data source.
425 "object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
426 # definition in the schema for the data source.
427 "properties": [ # The properties for the object.
428 # The maximum number of elements is 1000.
429 { # A typed name-value pair for structured data. The type of the value should
430 # be the same as the registered type for the `name` property in the object
431 # definition of `objectType`.
432 "objectValues": { # List of object values.
433 "values": [
434 # Object with schema name: StructuredDataObject
435 ],
436 },
437 "dateValues": { # List of date values.
438 "values": [
439 { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]440 "year": 42, # Year of date. Must be from 1 to 9999.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]441 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
442 "month": 42, # Month of date. Must be from 1 to 12.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]443 },
444 ],
445 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]446 "name": "A String", # The name of the property. This name should correspond to the name of the
447 # property that was registered for object definition in the schema.
448 # The maximum allowable length for this property is 256 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 "enumValues": { # List of enum values.
450 "values": [ # The maximum allowable length for string values is 32 characters.
451 "A String",
452 ],
453 },
454 "integerValues": { # List of integer values.
455 "values": [
456 "A String",
457 ],
458 },
459 "doubleValues": { # List of double values.
460 "values": [
461 3.14,
462 ],
463 },
464 "htmlValues": { # List of html values.
465 "values": [ # The maximum allowable length for html values is 2048 characters.
466 "A String",
467 ],
468 },
469 "booleanValue": True or False,
470 "timestampValues": { # List of timestamp values.
471 "values": [
472 "A String",
473 ],
474 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]475 "textValues": { # List of text values.
476 "values": [ # The maximum allowable length for text values is 2048 characters.
477 "A String",
478 ],
479 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]480 },
481 ],
482 },
483 "hash": "A String", # Hashing value provided by the API caller.
484 # This can be used with the
485 # items.push
486 # method to calculate modified state.
487 # The maximum length is 2048 characters.
488 },
489 "payload": "A String", # Additional state connector can store for this item.
490 # The maximum length is 10000 bytes.
491 "metadata": { # Available metadata fields for the item. # Metadata information.
492 "mimeType": "A String", # The original mime-type of
493 # ItemContent.content
494 # in the source repository.
495 # The maximum length is 256 characters.
496 "containerName": "A String", # The name of the container for this item.
497 # Deletion of the container item leads to automatic deletion of this
498 # item. Note: ACLs are not inherited from a container item.
499 # To provide ACL inheritance for an item, use the
500 # inheritAclFrom
501 # field. The maximum length is 1536 characters.
502 "updateTime": "A String", # The time when the item was last modified in the source repository.
503 "hash": "A String", # Hashing value provided by the API caller.
504 # This can be used with the
505 # items.push
506 # method to calculate modified state.
507 # The maximum length is 2048 characters.
508 "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For
509 # more information, see
510 # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
511 # The maximum length is 32 characters.
512 "title": "A String", # The title of the item. If given, this will be the displayed title of the
513 # Search result.
514 # The maximum length is 2048 characters.
515 "interactions": [ # A list of interactions for the item. Interactions are used to improve
516 # Search quality, but are not exposed to end users.
517 # The maximum number of elements is 1000.
518 { # Represents an interaction between a user and an item.
519 "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same
520 # type exist for a single user, only the most recent action is recorded.
521 "type": "A String",
522 "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
523 "userResourceName": "A String", # This principal is a user identified using an external identity.
524 # The name field must specify the user resource name with this format:
525 # identitysources/{source_id}/users/{ID}
526 "groupResourceName": "A String", # This principal is a group identified using an external identity.
527 # The name field must specify the group resource name with this format:
528 # identitysources/{source_id}/groups/{ID}
529 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
530 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
531 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
532 # customer.
533 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
534 },
535 },
536 },
537 ],
538 "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
539 "quality": 3.14, # An indication of the quality of the item, used to influence search quality.
540 # Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The
541 # default value is 0.0.
542 },
543 "keywords": [ # Additional keywords or phrases that should match the item.
544 # Used internally for user generated content.
545 # The maximum number of elements is 100.
546 # The maximum length is 8192 characters.
547 "A String",
548 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]549 "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &amp;#83;earch results apply
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]550 # this link to the title.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]551 # Whitespace or special characters may cause Cloud &amp;#83;earch result links to
552 # trigger a redirect notice; to avoid this, encode the URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553 # The maximum length is 2048 characters.
554 "createTime": "A String", # The time when the item was created in the source repository.
555 "objectType": "A String", # The type of the item. This should correspond to the name of an object
556 # definition in the schema registered for the data source. For example, if
557 # the schema for the data source contains an object definition with name
558 # 'document', then item indexing requests for objects of that type should set
559 # objectType to 'document'.
560 # The maximum length is 256 characters.
561 },
562 }</pre>
563</div>
564
565<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]566 <code class="details" id="index">index(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]567 <pre>Updates Item ACL, metadata, and
568content. It will insert the Item if it
569does not exist.
570This method does not support partial updates. Fields with no provided
571values are cleared out in the Cloud Search index.
572
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]573This API requires an admin or service account to execute. The service
574account used is the one whitelisted in the corresponding data source.
575
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]576Args:
577 name: string, Name of the Item. Format:
578datasources/{source_id}/items/{item_id}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]579&lt;br /&gt;This is a required field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580The maximum length is 1536 characters. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]581 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]582 The object takes the form of:
583
584{
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]585 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
586 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
587 # Otherwise, ignore this field.
588 },
589 "mode": "A String", # Required. The RequestMode for this request.
590 "connectorName": "A String", # Name of connector making this call.
591 # &lt;br /&gt;Format: datasources/{source_id}/connectors/{ID}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]592 "item": { # Represents a single object that is an item in the search index, such as a # Name of the item. Format:
593 # datasources/{source_id}/items/{item_id}
594 # file, folder, or a database record.
595 "status": { # This contains item's status and any errors. # Status of the item.
596 # Output only field.
597 "processingErrors": [ # Error details in case the item is in ERROR state.
598 {
599 "code": "A String", # Error code indicating the nature of the error.
600 "errorMessage": "A String", # Description of the error.
601 "fieldViolations": [ # In case the item fields are invalid, this field contains the details
602 # about the validation errors.
603 {
604 "field": "A String", # Path of field with violation.
605 "description": "A String", # Description of the error.
606 },
607 ],
608 },
609 ],
610 "repositoryErrors": [ # Repository error reported by connector.
611 { # Errors when the connector is communicating to the source repository.
612 "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
613 "errorMessage": "A String", # Message that describes the error. The maximum allowable length
614 # of the message is 8192 characters.
615 "type": "A String", # Type of error.
616 },
617 ],
618 "code": "A String", # Status code.
619 },
620 "queue": "A String", # Queue this item belongs to.
621 # The maximum length is 100 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]622 "itemType": "A String", # Type for this item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]623 "name": "A String", # Name of the Item. Format:
624 # datasources/{source_id}/items/{item_id}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]625 # &lt;br /&gt;This is a required field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]626 # The maximum length is 1536 characters.
627 "acl": { # Access control list information for the item. For more information see # Access control list for this item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]628 # [Map ACLs](/cloud-search/docs/guides/acls).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]629 "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
630 # parent. This should always be set in tandem with the
631 # inheritAclFrom
632 # field. Also, when the
633 # inheritAclFrom field
634 # is set, this field should be set to a valid AclInheritanceType.
635 "readers": [ # List of principals who are allowed to see the item in search results.
636 # Optional if inheriting permissions from another item or if the item
637 # is not intended to be visible, such as
638 # virtual
639 # containers.
640 # The maximum number of elements is 1000.
641 { # Reference to a user, group, or domain.
642 "userResourceName": "A String", # This principal is a user identified using an external identity.
643 # The name field must specify the user resource name with this format:
644 # identitysources/{source_id}/users/{ID}
645 "groupResourceName": "A String", # This principal is a group identified using an external identity.
646 # The name field must specify the group resource name with this format:
647 # identitysources/{source_id}/groups/{ID}
648 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
649 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
650 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
651 # customer.
652 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
653 },
654 },
655 ],
656 "deniedReaders": [ # List of principals who are explicitly denied access to the item in search
657 # results. While principals are denied access by default, use denied readers
658 # to handle exceptions and override the list allowed readers.
659 # The maximum number of elements is 100.
660 { # Reference to a user, group, or domain.
661 "userResourceName": "A String", # This principal is a user identified using an external identity.
662 # The name field must specify the user resource name with this format:
663 # identitysources/{source_id}/users/{ID}
664 "groupResourceName": "A String", # This principal is a group identified using an external identity.
665 # The name field must specify the group resource name with this format:
666 # identitysources/{source_id}/groups/{ID}
667 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
668 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
669 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
670 # customer.
671 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
672 },
673 },
674 ],
675 "owners": [ # Optional. List of owners for the item. This field has no bearing on
676 # document access permissions. It does, however, offer
677 # a slight ranking boosts items where the querying user is an owner.
678 # The maximum number of elements is 5.
679 { # Reference to a user, group, or domain.
680 "userResourceName": "A String", # This principal is a user identified using an external identity.
681 # The name field must specify the user resource name with this format:
682 # identitysources/{source_id}/users/{ID}
683 "groupResourceName": "A String", # This principal is a group identified using an external identity.
684 # The name field must specify the group resource name with this format:
685 # identitysources/{source_id}/groups/{ID}
686 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
687 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
688 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
689 # customer.
690 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
691 },
692 },
693 ],
694 "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
695 # Note: ACL inheritance *only* provides access permissions
696 # to child items and does not define structural relationships, nor does it
697 # provide convenient ways to delete large groups of items.
698 # Deleting an ACL parent from the index only alters the access permissions of
699 # child items that reference the parent in the
700 # inheritAclFrom
701 # field. The item is still in the index, but may not
702 # visible in search results. By contrast, deletion of a container item
703 # also deletes all items that reference the container via the
704 # containerName
705 # field.
706 # The maximum length for this field is 1536 characters.
707 },
708 "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
709 "contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
710 # This reference is created via upload
711 # method.
712 # Updating of item content may refer to this uploaded content via
713 # contentDataRef.
714 "name": "A String", # Name of the content reference.
715 # The maximum length is 2048 characters.
716 },
717 "contentFormat": "A String",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]718 "inlineContent": "A String", # Content that is supplied inlined within the update method.
719 # The maximum length is 102400 bytes (100 KiB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]720 "hash": "A String", # Hashing info calculated and provided by the API client for content.
721 # Can be used with the items.push method to calculate modified state.
722 # The maximum length is 2048 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]723 },
724 "version": "A String", # Required. The indexing system stores the version from the datasource as a
725 # byte string and compares the Item version in the index
726 # to the version of the queued Item using lexical ordering.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]727 # &lt;br /&gt;&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]728 # Cloud Search Indexing won't index or delete any queued item with
729 # a version value that is less than or equal to the version of the
730 # currently indexed item.
731 # The maximum length for this field is 1024 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]732 "structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
733 # object definition in the schema for the data source.
734 "object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
735 # definition in the schema for the data source.
736 "properties": [ # The properties for the object.
737 # The maximum number of elements is 1000.
738 { # A typed name-value pair for structured data. The type of the value should
739 # be the same as the registered type for the `name` property in the object
740 # definition of `objectType`.
741 "objectValues": { # List of object values.
742 "values": [
743 # Object with schema name: StructuredDataObject
744 ],
745 },
746 "dateValues": { # List of date values.
747 "values": [
748 { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]749 "year": 42, # Year of date. Must be from 1 to 9999.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]750 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
751 "month": 42, # Month of date. Must be from 1 to 12.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]752 },
753 ],
754 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]755 "name": "A String", # The name of the property. This name should correspond to the name of the
756 # property that was registered for object definition in the schema.
757 # The maximum allowable length for this property is 256 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]758 "enumValues": { # List of enum values.
759 "values": [ # The maximum allowable length for string values is 32 characters.
760 "A String",
761 ],
762 },
763 "integerValues": { # List of integer values.
764 "values": [
765 "A String",
766 ],
767 },
768 "doubleValues": { # List of double values.
769 "values": [
770 3.14,
771 ],
772 },
773 "htmlValues": { # List of html values.
774 "values": [ # The maximum allowable length for html values is 2048 characters.
775 "A String",
776 ],
777 },
778 "booleanValue": True or False,
779 "timestampValues": { # List of timestamp values.
780 "values": [
781 "A String",
782 ],
783 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]784 "textValues": { # List of text values.
785 "values": [ # The maximum allowable length for text values is 2048 characters.
786 "A String",
787 ],
788 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]789 },
790 ],
791 },
792 "hash": "A String", # Hashing value provided by the API caller.
793 # This can be used with the
794 # items.push
795 # method to calculate modified state.
796 # The maximum length is 2048 characters.
797 },
798 "payload": "A String", # Additional state connector can store for this item.
799 # The maximum length is 10000 bytes.
800 "metadata": { # Available metadata fields for the item. # Metadata information.
801 "mimeType": "A String", # The original mime-type of
802 # ItemContent.content
803 # in the source repository.
804 # The maximum length is 256 characters.
805 "containerName": "A String", # The name of the container for this item.
806 # Deletion of the container item leads to automatic deletion of this
807 # item. Note: ACLs are not inherited from a container item.
808 # To provide ACL inheritance for an item, use the
809 # inheritAclFrom
810 # field. The maximum length is 1536 characters.
811 "updateTime": "A String", # The time when the item was last modified in the source repository.
812 "hash": "A String", # Hashing value provided by the API caller.
813 # This can be used with the
814 # items.push
815 # method to calculate modified state.
816 # The maximum length is 2048 characters.
817 "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For
818 # more information, see
819 # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
820 # The maximum length is 32 characters.
821 "title": "A String", # The title of the item. If given, this will be the displayed title of the
822 # Search result.
823 # The maximum length is 2048 characters.
824 "interactions": [ # A list of interactions for the item. Interactions are used to improve
825 # Search quality, but are not exposed to end users.
826 # The maximum number of elements is 1000.
827 { # Represents an interaction between a user and an item.
828 "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same
829 # type exist for a single user, only the most recent action is recorded.
830 "type": "A String",
831 "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
832 "userResourceName": "A String", # This principal is a user identified using an external identity.
833 # The name field must specify the user resource name with this format:
834 # identitysources/{source_id}/users/{ID}
835 "groupResourceName": "A String", # This principal is a group identified using an external identity.
836 # The name field must specify the group resource name with this format:
837 # identitysources/{source_id}/groups/{ID}
838 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
839 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
840 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
841 # customer.
842 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
843 },
844 },
845 },
846 ],
847 "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
848 "quality": 3.14, # An indication of the quality of the item, used to influence search quality.
849 # Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The
850 # default value is 0.0.
851 },
852 "keywords": [ # Additional keywords or phrases that should match the item.
853 # Used internally for user generated content.
854 # The maximum number of elements is 100.
855 # The maximum length is 8192 characters.
856 "A String",
857 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]858 "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &amp;#83;earch results apply
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]859 # this link to the title.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]860 # Whitespace or special characters may cause Cloud &amp;#83;earch result links to
861 # trigger a redirect notice; to avoid this, encode the URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]862 # The maximum length is 2048 characters.
863 "createTime": "A String", # The time when the item was created in the source repository.
864 "objectType": "A String", # The type of the item. This should correspond to the name of an object
865 # definition in the schema registered for the data source. For example, if
866 # the schema for the data source contains an object definition with name
867 # 'document', then item indexing requests for objects of that type should set
868 # objectType to 'document'.
869 # The maximum length is 256 characters.
870 },
871 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]872 "indexItemOptions": {
873 "allowUnknownGsuitePrincipals": True or False, # Specifies if the index request should allow gsuite principals that do not
874 # exist or are deleted in the index request.
875 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]876 }
877
878 x__xgafv: string, V1 error format.
879 Allowed values
880 1 - v1 error format
881 2 - v2 error format
882
883Returns:
884 An object of the form:
885
886 { # This resource represents a long-running operation that is the result of a
887 # network API call.
888 "metadata": { # Service-specific metadata associated with the operation. It typically
889 # contains progress information and common metadata such as create time.
890 # Some services might not provide such metadata. Any method that returns a
891 # long-running operation should document the metadata type, if any.
892 "a_key": "", # Properties of the object. Contains field @type with type URL.
893 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]894 "done": True or False, # If the value is `false`, it means the operation is still in progress.
895 # If `true`, the operation is completed, and either `error` or `response` is
896 # available.
897 "response": { # The normal response of the operation in case of success. If the original
898 # method returns no data on success, such as `Delete`, the response is
899 # `google.protobuf.Empty`. If the original method is standard
900 # `Get`/`Create`/`Update`, the response should be the resource. For other
901 # methods, the response should have the type `XxxResponse`, where `Xxx`
902 # is the original method name. For example, if the original method name
903 # is `TakeSnapshot()`, the inferred response type is
904 # `TakeSnapshotResponse`.
905 "a_key": "", # Properties of the object. Contains field @type with type URL.
906 },
907 "name": "A String", # The server-assigned name, which is only unique within the same service that
908 # originally returns it. If you use the default HTTP mapping, the
909 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]910 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
911 # different programming environments, including REST APIs and RPC APIs. It is
912 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
913 # three pieces of data: error code, error message, and error details.
914 #
915 # You can find out more about this error model and how to work with it in the
916 # [API Design Guide](https://cloud.google.com/apis/design/errors).
917 "message": "A String", # A developer-facing error message, which should be in English. Any
918 # user-facing error message should be localized and sent in the
919 # google.rpc.Status.details field, or localized by the client.
920 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
921 "details": [ # A list of messages that carry the error details. There is a common set of
922 # message types for APIs to use.
923 {
924 "a_key": "", # Properties of the object. Contains field @type with type URL.
925 },
926 ],
927 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]928 }</pre>
929</div>
930
931<div class="method">
932 <code class="details" id="list">list(name, pageSize=None, brief=None, connectorName=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</code>
933 <pre>Lists all or a subset of Item resources.
934
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]935This API requires an admin or service account to execute. The service
936account used is the one whitelisted in the corresponding data source.
937
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]938Args:
939 name: string, Name of the Data Source to list Items. Format:
940datasources/{source_id} (required)
941 pageSize: integer, Maximum number of items to fetch in a request.
942The max value is 1000 when brief is true. The max value is 10 if brief
943is false.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]944&lt;br /&gt;The default value is 10
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]945 brief: boolean, When set to true, the indexing system only populates the following fields:
946name,
947version,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]948queue.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]949metadata.hash,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]950metadata.title,
951metadata.sourceRepositoryURL,
952metadata.objectType,
953metadata.createTime,
954metadata.updateTime,
955metadata.contentLanguage,
956metadata.mimeType,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]957structured_data.hash,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]958content.hash,
959itemType,
960itemStatus.code,
961itemStatus.processingError.code,
962itemStatus.repositoryError.type,
963&lt;br /&gt;If this value is false, then all the fields are populated in Item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]964 connectorName: string, Name of connector making this call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]965&lt;br /&gt;Format: datasources/{source_id}/connectors/{ID}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]966 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
967Otherwise, ignore this field.
968 pageToken: string, The next_page_token value returned from a previous List request, if any.
969 x__xgafv: string, V1 error format.
970 Allowed values
971 1 - v1 error format
972 2 - v2 error format
973
974Returns:
975 An object of the form:
976
977 {
978 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
979 # more results in the list.
980 "items": [
981 { # Represents a single object that is an item in the search index, such as a
982 # file, folder, or a database record.
983 "status": { # This contains item's status and any errors. # Status of the item.
984 # Output only field.
985 "processingErrors": [ # Error details in case the item is in ERROR state.
986 {
987 "code": "A String", # Error code indicating the nature of the error.
988 "errorMessage": "A String", # Description of the error.
989 "fieldViolations": [ # In case the item fields are invalid, this field contains the details
990 # about the validation errors.
991 {
992 "field": "A String", # Path of field with violation.
993 "description": "A String", # Description of the error.
994 },
995 ],
996 },
997 ],
998 "repositoryErrors": [ # Repository error reported by connector.
999 { # Errors when the connector is communicating to the source repository.
1000 "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
1001 "errorMessage": "A String", # Message that describes the error. The maximum allowable length
1002 # of the message is 8192 characters.
1003 "type": "A String", # Type of error.
1004 },
1005 ],
1006 "code": "A String", # Status code.
1007 },
1008 "queue": "A String", # Queue this item belongs to.
1009 # The maximum length is 100 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1010 "itemType": "A String", # Type for this item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1011 "name": "A String", # Name of the Item. Format:
1012 # datasources/{source_id}/items/{item_id}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1013 # &lt;br /&gt;This is a required field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1014 # The maximum length is 1536 characters.
1015 "acl": { # Access control list information for the item. For more information see # Access control list for this item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1016 # [Map ACLs](/cloud-search/docs/guides/acls).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1017 "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
1018 # parent. This should always be set in tandem with the
1019 # inheritAclFrom
1020 # field. Also, when the
1021 # inheritAclFrom field
1022 # is set, this field should be set to a valid AclInheritanceType.
1023 "readers": [ # List of principals who are allowed to see the item in search results.
1024 # Optional if inheriting permissions from another item or if the item
1025 # is not intended to be visible, such as
1026 # virtual
1027 # containers.
1028 # The maximum number of elements is 1000.
1029 { # Reference to a user, group, or domain.
1030 "userResourceName": "A String", # This principal is a user identified using an external identity.
1031 # The name field must specify the user resource name with this format:
1032 # identitysources/{source_id}/users/{ID}
1033 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1034 # The name field must specify the group resource name with this format:
1035 # identitysources/{source_id}/groups/{ID}
1036 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1037 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1038 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1039 # customer.
1040 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1041 },
1042 },
1043 ],
1044 "deniedReaders": [ # List of principals who are explicitly denied access to the item in search
1045 # results. While principals are denied access by default, use denied readers
1046 # to handle exceptions and override the list allowed readers.
1047 # The maximum number of elements is 100.
1048 { # Reference to a user, group, or domain.
1049 "userResourceName": "A String", # This principal is a user identified using an external identity.
1050 # The name field must specify the user resource name with this format:
1051 # identitysources/{source_id}/users/{ID}
1052 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1053 # The name field must specify the group resource name with this format:
1054 # identitysources/{source_id}/groups/{ID}
1055 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1056 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1057 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1058 # customer.
1059 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1060 },
1061 },
1062 ],
1063 "owners": [ # Optional. List of owners for the item. This field has no bearing on
1064 # document access permissions. It does, however, offer
1065 # a slight ranking boosts items where the querying user is an owner.
1066 # The maximum number of elements is 5.
1067 { # Reference to a user, group, or domain.
1068 "userResourceName": "A String", # This principal is a user identified using an external identity.
1069 # The name field must specify the user resource name with this format:
1070 # identitysources/{source_id}/users/{ID}
1071 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1072 # The name field must specify the group resource name with this format:
1073 # identitysources/{source_id}/groups/{ID}
1074 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1075 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1076 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1077 # customer.
1078 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1079 },
1080 },
1081 ],
1082 "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
1083 # Note: ACL inheritance *only* provides access permissions
1084 # to child items and does not define structural relationships, nor does it
1085 # provide convenient ways to delete large groups of items.
1086 # Deleting an ACL parent from the index only alters the access permissions of
1087 # child items that reference the parent in the
1088 # inheritAclFrom
1089 # field. The item is still in the index, but may not
1090 # visible in search results. By contrast, deletion of a container item
1091 # also deletes all items that reference the container via the
1092 # containerName
1093 # field.
1094 # The maximum length for this field is 1536 characters.
1095 },
1096 "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
1097 "contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
1098 # This reference is created via upload
1099 # method.
1100 # Updating of item content may refer to this uploaded content via
1101 # contentDataRef.
1102 "name": "A String", # Name of the content reference.
1103 # The maximum length is 2048 characters.
1104 },
1105 "contentFormat": "A String",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1106 "inlineContent": "A String", # Content that is supplied inlined within the update method.
1107 # The maximum length is 102400 bytes (100 KiB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1108 "hash": "A String", # Hashing info calculated and provided by the API client for content.
1109 # Can be used with the items.push method to calculate modified state.
1110 # The maximum length is 2048 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1111 },
1112 "version": "A String", # Required. The indexing system stores the version from the datasource as a
1113 # byte string and compares the Item version in the index
1114 # to the version of the queued Item using lexical ordering.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1115 # &lt;br /&gt;&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1116 # Cloud Search Indexing won't index or delete any queued item with
1117 # a version value that is less than or equal to the version of the
1118 # currently indexed item.
1119 # The maximum length for this field is 1024 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1120 "structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
1121 # object definition in the schema for the data source.
1122 "object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
1123 # definition in the schema for the data source.
1124 "properties": [ # The properties for the object.
1125 # The maximum number of elements is 1000.
1126 { # A typed name-value pair for structured data. The type of the value should
1127 # be the same as the registered type for the `name` property in the object
1128 # definition of `objectType`.
1129 "objectValues": { # List of object values.
1130 "values": [
1131 # Object with schema name: StructuredDataObject
1132 ],
1133 },
1134 "dateValues": { # List of date values.
1135 "values": [
1136 { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1137 "year": 42, # Year of date. Must be from 1 to 9999.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1138 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
1139 "month": 42, # Month of date. Must be from 1 to 12.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1140 },
1141 ],
1142 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1143 "name": "A String", # The name of the property. This name should correspond to the name of the
1144 # property that was registered for object definition in the schema.
1145 # The maximum allowable length for this property is 256 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1146 "enumValues": { # List of enum values.
1147 "values": [ # The maximum allowable length for string values is 32 characters.
1148 "A String",
1149 ],
1150 },
1151 "integerValues": { # List of integer values.
1152 "values": [
1153 "A String",
1154 ],
1155 },
1156 "doubleValues": { # List of double values.
1157 "values": [
1158 3.14,
1159 ],
1160 },
1161 "htmlValues": { # List of html values.
1162 "values": [ # The maximum allowable length for html values is 2048 characters.
1163 "A String",
1164 ],
1165 },
1166 "booleanValue": True or False,
1167 "timestampValues": { # List of timestamp values.
1168 "values": [
1169 "A String",
1170 ],
1171 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1172 "textValues": { # List of text values.
1173 "values": [ # The maximum allowable length for text values is 2048 characters.
1174 "A String",
1175 ],
1176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1177 },
1178 ],
1179 },
1180 "hash": "A String", # Hashing value provided by the API caller.
1181 # This can be used with the
1182 # items.push
1183 # method to calculate modified state.
1184 # The maximum length is 2048 characters.
1185 },
1186 "payload": "A String", # Additional state connector can store for this item.
1187 # The maximum length is 10000 bytes.
1188 "metadata": { # Available metadata fields for the item. # Metadata information.
1189 "mimeType": "A String", # The original mime-type of
1190 # ItemContent.content
1191 # in the source repository.
1192 # The maximum length is 256 characters.
1193 "containerName": "A String", # The name of the container for this item.
1194 # Deletion of the container item leads to automatic deletion of this
1195 # item. Note: ACLs are not inherited from a container item.
1196 # To provide ACL inheritance for an item, use the
1197 # inheritAclFrom
1198 # field. The maximum length is 1536 characters.
1199 "updateTime": "A String", # The time when the item was last modified in the source repository.
1200 "hash": "A String", # Hashing value provided by the API caller.
1201 # This can be used with the
1202 # items.push
1203 # method to calculate modified state.
1204 # The maximum length is 2048 characters.
1205 "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For
1206 # more information, see
1207 # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
1208 # The maximum length is 32 characters.
1209 "title": "A String", # The title of the item. If given, this will be the displayed title of the
1210 # Search result.
1211 # The maximum length is 2048 characters.
1212 "interactions": [ # A list of interactions for the item. Interactions are used to improve
1213 # Search quality, but are not exposed to end users.
1214 # The maximum number of elements is 1000.
1215 { # Represents an interaction between a user and an item.
1216 "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same
1217 # type exist for a single user, only the most recent action is recorded.
1218 "type": "A String",
1219 "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
1220 "userResourceName": "A String", # This principal is a user identified using an external identity.
1221 # The name field must specify the user resource name with this format:
1222 # identitysources/{source_id}/users/{ID}
1223 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1224 # The name field must specify the group resource name with this format:
1225 # identitysources/{source_id}/groups/{ID}
1226 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1227 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1228 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1229 # customer.
1230 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1231 },
1232 },
1233 },
1234 ],
1235 "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
1236 "quality": 3.14, # An indication of the quality of the item, used to influence search quality.
1237 # Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The
1238 # default value is 0.0.
1239 },
1240 "keywords": [ # Additional keywords or phrases that should match the item.
1241 # Used internally for user generated content.
1242 # The maximum number of elements is 100.
1243 # The maximum length is 8192 characters.
1244 "A String",
1245 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1246 "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &amp;#83;earch results apply
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1247 # this link to the title.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1248 # Whitespace or special characters may cause Cloud &amp;#83;earch result links to
1249 # trigger a redirect notice; to avoid this, encode the URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1250 # The maximum length is 2048 characters.
1251 "createTime": "A String", # The time when the item was created in the source repository.
1252 "objectType": "A String", # The type of the item. This should correspond to the name of an object
1253 # definition in the schema registered for the data source. For example, if
1254 # the schema for the data source contains an object definition with name
1255 # 'document', then item indexing requests for objects of that type should set
1256 # objectType to 'document'.
1257 # The maximum length is 256 characters.
1258 },
1259 },
1260 ],
1261 }</pre>
1262</div>
1263
1264<div class="method">
1265 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1266 <pre>Retrieves the next page of results.
1267
1268Args:
1269 previous_request: The request for the previous page. (required)
1270 previous_response: The response from the request for the previous page. (required)
1271
1272Returns:
1273 A request object that you can call 'execute()' on to request the next
1274 page. Returns None if there are no more items in the collection.
1275 </pre>
1276</div>
1277
1278<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1279 <code class="details" id="poll">poll(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1280 <pre>Polls for unreserved items from the indexing queue and marks a
1281set as reserved, starting with items that have
1282the oldest timestamp from the highest priority
1283ItemStatus.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1284The priority order is as follows: &lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1285ERROR
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1286&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1287MODIFIED
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1288&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1289NEW_ITEM
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1290&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1291ACCEPTED
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1292&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1293Reserving items ensures that polling from other threads
1294cannot create overlapping sets.
1295
1296After handling the reserved items, the client should put items back
1297into the unreserved state, either by calling
1298index,
1299or by calling
1300push with
1301the type REQUEUE.
1302
1303Items automatically become available (unreserved) after 4 hours even if no
1304update or push method is called.
1305
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1306This API requires an admin or service account to execute. The service
1307account used is the one whitelisted in the corresponding data source.
1308
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1309Args:
1310 name: string, Name of the Data Source to poll items.
1311Format: datasources/{source_id} (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1312 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1313 The object takes the form of:
1314
1315{
1316 "queue": "A String", # Queue name to fetch items from. If unspecified, PollItems will
1317 # fetch from 'default' queue.
1318 # The maximum length is 100 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1319 "connectorName": "A String", # Name of connector making this call.
1320 # &lt;br /&gt;Format: datasources/{source_id}/connectors/{ID}
1321 "limit": 42, # Maximum number of items to return.
1322 # &lt;br /&gt;The maximum value is 100 and the default value is 20.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1323 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
1324 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
1325 # Otherwise, ignore this field.
1326 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1327 "statusCodes": [ # Limit the items polled to the ones with these statuses.
1328 "A String",
1329 ],
1330 }
1331
1332 x__xgafv: string, V1 error format.
1333 Allowed values
1334 1 - v1 error format
1335 2 - v2 error format
1336
1337Returns:
1338 An object of the form:
1339
1340 {
1341 "items": [ # Set of items from the queue available for connector to process.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1342 # &lt;br /&gt;These items have the following subset of fields populated: &lt;br /&gt;
1343 # &lt;br /&gt;version
1344 # &lt;br /&gt;metadata.hash
1345 # &lt;br /&gt;structured_data.hash
1346 # &lt;br /&gt;content.hash
1347 # &lt;br /&gt;payload
1348 # &lt;br /&gt;status
1349 # &lt;br /&gt;queue
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1350 { # Represents a single object that is an item in the search index, such as a
1351 # file, folder, or a database record.
1352 "status": { # This contains item's status and any errors. # Status of the item.
1353 # Output only field.
1354 "processingErrors": [ # Error details in case the item is in ERROR state.
1355 {
1356 "code": "A String", # Error code indicating the nature of the error.
1357 "errorMessage": "A String", # Description of the error.
1358 "fieldViolations": [ # In case the item fields are invalid, this field contains the details
1359 # about the validation errors.
1360 {
1361 "field": "A String", # Path of field with violation.
1362 "description": "A String", # Description of the error.
1363 },
1364 ],
1365 },
1366 ],
1367 "repositoryErrors": [ # Repository error reported by connector.
1368 { # Errors when the connector is communicating to the source repository.
1369 "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
1370 "errorMessage": "A String", # Message that describes the error. The maximum allowable length
1371 # of the message is 8192 characters.
1372 "type": "A String", # Type of error.
1373 },
1374 ],
1375 "code": "A String", # Status code.
1376 },
1377 "queue": "A String", # Queue this item belongs to.
1378 # The maximum length is 100 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1379 "itemType": "A String", # Type for this item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1380 "name": "A String", # Name of the Item. Format:
1381 # datasources/{source_id}/items/{item_id}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1382 # &lt;br /&gt;This is a required field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1383 # The maximum length is 1536 characters.
1384 "acl": { # Access control list information for the item. For more information see # Access control list for this item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1385 # [Map ACLs](/cloud-search/docs/guides/acls).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1386 "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
1387 # parent. This should always be set in tandem with the
1388 # inheritAclFrom
1389 # field. Also, when the
1390 # inheritAclFrom field
1391 # is set, this field should be set to a valid AclInheritanceType.
1392 "readers": [ # List of principals who are allowed to see the item in search results.
1393 # Optional if inheriting permissions from another item or if the item
1394 # is not intended to be visible, such as
1395 # virtual
1396 # containers.
1397 # The maximum number of elements is 1000.
1398 { # Reference to a user, group, or domain.
1399 "userResourceName": "A String", # This principal is a user identified using an external identity.
1400 # The name field must specify the user resource name with this format:
1401 # identitysources/{source_id}/users/{ID}
1402 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1403 # The name field must specify the group resource name with this format:
1404 # identitysources/{source_id}/groups/{ID}
1405 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1406 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1407 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1408 # customer.
1409 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1410 },
1411 },
1412 ],
1413 "deniedReaders": [ # List of principals who are explicitly denied access to the item in search
1414 # results. While principals are denied access by default, use denied readers
1415 # to handle exceptions and override the list allowed readers.
1416 # The maximum number of elements is 100.
1417 { # Reference to a user, group, or domain.
1418 "userResourceName": "A String", # This principal is a user identified using an external identity.
1419 # The name field must specify the user resource name with this format:
1420 # identitysources/{source_id}/users/{ID}
1421 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1422 # The name field must specify the group resource name with this format:
1423 # identitysources/{source_id}/groups/{ID}
1424 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1425 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1426 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1427 # customer.
1428 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1429 },
1430 },
1431 ],
1432 "owners": [ # Optional. List of owners for the item. This field has no bearing on
1433 # document access permissions. It does, however, offer
1434 # a slight ranking boosts items where the querying user is an owner.
1435 # The maximum number of elements is 5.
1436 { # Reference to a user, group, or domain.
1437 "userResourceName": "A String", # This principal is a user identified using an external identity.
1438 # The name field must specify the user resource name with this format:
1439 # identitysources/{source_id}/users/{ID}
1440 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1441 # The name field must specify the group resource name with this format:
1442 # identitysources/{source_id}/groups/{ID}
1443 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1444 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1445 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1446 # customer.
1447 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1448 },
1449 },
1450 ],
1451 "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
1452 # Note: ACL inheritance *only* provides access permissions
1453 # to child items and does not define structural relationships, nor does it
1454 # provide convenient ways to delete large groups of items.
1455 # Deleting an ACL parent from the index only alters the access permissions of
1456 # child items that reference the parent in the
1457 # inheritAclFrom
1458 # field. The item is still in the index, but may not
1459 # visible in search results. By contrast, deletion of a container item
1460 # also deletes all items that reference the container via the
1461 # containerName
1462 # field.
1463 # The maximum length for this field is 1536 characters.
1464 },
1465 "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
1466 "contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
1467 # This reference is created via upload
1468 # method.
1469 # Updating of item content may refer to this uploaded content via
1470 # contentDataRef.
1471 "name": "A String", # Name of the content reference.
1472 # The maximum length is 2048 characters.
1473 },
1474 "contentFormat": "A String",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1475 "inlineContent": "A String", # Content that is supplied inlined within the update method.
1476 # The maximum length is 102400 bytes (100 KiB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1477 "hash": "A String", # Hashing info calculated and provided by the API client for content.
1478 # Can be used with the items.push method to calculate modified state.
1479 # The maximum length is 2048 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1480 },
1481 "version": "A String", # Required. The indexing system stores the version from the datasource as a
1482 # byte string and compares the Item version in the index
1483 # to the version of the queued Item using lexical ordering.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1484 # &lt;br /&gt;&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1485 # Cloud Search Indexing won't index or delete any queued item with
1486 # a version value that is less than or equal to the version of the
1487 # currently indexed item.
1488 # The maximum length for this field is 1024 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1489 "structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
1490 # object definition in the schema for the data source.
1491 "object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
1492 # definition in the schema for the data source.
1493 "properties": [ # The properties for the object.
1494 # The maximum number of elements is 1000.
1495 { # A typed name-value pair for structured data. The type of the value should
1496 # be the same as the registered type for the `name` property in the object
1497 # definition of `objectType`.
1498 "objectValues": { # List of object values.
1499 "values": [
1500 # Object with schema name: StructuredDataObject
1501 ],
1502 },
1503 "dateValues": { # List of date values.
1504 "values": [
1505 { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1506 "year": 42, # Year of date. Must be from 1 to 9999.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1507 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
1508 "month": 42, # Month of date. Must be from 1 to 12.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1509 },
1510 ],
1511 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1512 "name": "A String", # The name of the property. This name should correspond to the name of the
1513 # property that was registered for object definition in the schema.
1514 # The maximum allowable length for this property is 256 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1515 "enumValues": { # List of enum values.
1516 "values": [ # The maximum allowable length for string values is 32 characters.
1517 "A String",
1518 ],
1519 },
1520 "integerValues": { # List of integer values.
1521 "values": [
1522 "A String",
1523 ],
1524 },
1525 "doubleValues": { # List of double values.
1526 "values": [
1527 3.14,
1528 ],
1529 },
1530 "htmlValues": { # List of html values.
1531 "values": [ # The maximum allowable length for html values is 2048 characters.
1532 "A String",
1533 ],
1534 },
1535 "booleanValue": True or False,
1536 "timestampValues": { # List of timestamp values.
1537 "values": [
1538 "A String",
1539 ],
1540 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1541 "textValues": { # List of text values.
1542 "values": [ # The maximum allowable length for text values is 2048 characters.
1543 "A String",
1544 ],
1545 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1546 },
1547 ],
1548 },
1549 "hash": "A String", # Hashing value provided by the API caller.
1550 # This can be used with the
1551 # items.push
1552 # method to calculate modified state.
1553 # The maximum length is 2048 characters.
1554 },
1555 "payload": "A String", # Additional state connector can store for this item.
1556 # The maximum length is 10000 bytes.
1557 "metadata": { # Available metadata fields for the item. # Metadata information.
1558 "mimeType": "A String", # The original mime-type of
1559 # ItemContent.content
1560 # in the source repository.
1561 # The maximum length is 256 characters.
1562 "containerName": "A String", # The name of the container for this item.
1563 # Deletion of the container item leads to automatic deletion of this
1564 # item. Note: ACLs are not inherited from a container item.
1565 # To provide ACL inheritance for an item, use the
1566 # inheritAclFrom
1567 # field. The maximum length is 1536 characters.
1568 "updateTime": "A String", # The time when the item was last modified in the source repository.
1569 "hash": "A String", # Hashing value provided by the API caller.
1570 # This can be used with the
1571 # items.push
1572 # method to calculate modified state.
1573 # The maximum length is 2048 characters.
1574 "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For
1575 # more information, see
1576 # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
1577 # The maximum length is 32 characters.
1578 "title": "A String", # The title of the item. If given, this will be the displayed title of the
1579 # Search result.
1580 # The maximum length is 2048 characters.
1581 "interactions": [ # A list of interactions for the item. Interactions are used to improve
1582 # Search quality, but are not exposed to end users.
1583 # The maximum number of elements is 1000.
1584 { # Represents an interaction between a user and an item.
1585 "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same
1586 # type exist for a single user, only the most recent action is recorded.
1587 "type": "A String",
1588 "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
1589 "userResourceName": "A String", # This principal is a user identified using an external identity.
1590 # The name field must specify the user resource name with this format:
1591 # identitysources/{source_id}/users/{ID}
1592 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1593 # The name field must specify the group resource name with this format:
1594 # identitysources/{source_id}/groups/{ID}
1595 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1596 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1597 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1598 # customer.
1599 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1600 },
1601 },
1602 },
1603 ],
1604 "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
1605 "quality": 3.14, # An indication of the quality of the item, used to influence search quality.
1606 # Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The
1607 # default value is 0.0.
1608 },
1609 "keywords": [ # Additional keywords or phrases that should match the item.
1610 # Used internally for user generated content.
1611 # The maximum number of elements is 100.
1612 # The maximum length is 8192 characters.
1613 "A String",
1614 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1615 "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &amp;#83;earch results apply
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1616 # this link to the title.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1617 # Whitespace or special characters may cause Cloud &amp;#83;earch result links to
1618 # trigger a redirect notice; to avoid this, encode the URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1619 # The maximum length is 2048 characters.
1620 "createTime": "A String", # The time when the item was created in the source repository.
1621 "objectType": "A String", # The type of the item. This should correspond to the name of an object
1622 # definition in the schema registered for the data source. For example, if
1623 # the schema for the data source contains an object definition with name
1624 # 'document', then item indexing requests for objects of that type should set
1625 # objectType to 'document'.
1626 # The maximum length is 256 characters.
1627 },
1628 },
1629 ],
1630 }</pre>
1631</div>
1632
1633<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1634 <code class="details" id="push">push(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1635 <pre>Pushes an item onto a queue for later polling and updating.
1636
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1637This API requires an admin or service account to execute. The service
1638account used is the one whitelisted in the corresponding data source.
1639
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1640Args:
1641 name: string, Name of the item to
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1642push into the indexing queue.&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1643Format: datasources/{source_id}/items/{ID}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1644&lt;br /&gt;This is a required field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1645The maximum length is 1536 characters. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1646 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1647 The object takes the form of:
1648
1649{
1650 "item": { # Represents an item to be pushed to the indexing queue. # Item to push onto the queue.
1651 "contentHash": "A String", # Content hash of the item according to the repository. If specified, this is
1652 # used to determine how to modify this
1653 # item's status. Setting this field and the
1654 # type field results in argument
1655 # error.
1656 # The maximum length is 2048 characters.
1657 "metadataHash": "A String", # Metadata hash of the item according to the repository. If specified, this
1658 # is used to determine how to modify this
1659 # item's status. Setting this field and the
1660 # type field results in argument
1661 # error.
1662 # The maximum length is 2048 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1663 "queue": "A String", # Queue to which this item belongs to. The &lt;code&gt;default&lt;/code&gt; queue is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1664 # chosen if this field is not specified. The maximum length is
1665 # 512 characters.
1666 "repositoryError": { # Errors when the connector is communicating to the source repository. # Populate this field to store Connector or repository error details.
1667 # This information is displayed in the Admin Console.
1668 # This field may only be populated when the
1669 # Type is
1670 # REPOSITORY_ERROR.
1671 "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
1672 "errorMessage": "A String", # Message that describes the error. The maximum allowable length
1673 # of the message is 8192 characters.
1674 "type": "A String", # Type of error.
1675 },
1676 "structuredDataHash": "A String", # Structured data hash of the item according to the repository. If specified,
1677 # this is used to determine how to modify this item's status. Setting this
1678 # field and the type field
1679 # results in argument error.
1680 # The maximum length is 2048 characters.
1681 "type": "A String", # The type of the push operation that defines the push behavior.
1682 "payload": "A String", # Provides additional document state information for the connector,
1683 # such as an alternate repository ID and other metadata.
1684 # The maximum length is 8192 bytes.
1685 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1686 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
1687 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
1688 # Otherwise, ignore this field.
1689 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1690 "connectorName": "A String", # Name of connector making this call.
1691 # &lt;br /&gt;Format: datasources/{source_id}/connectors/{ID}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1692 }
1693
1694 x__xgafv: string, V1 error format.
1695 Allowed values
1696 1 - v1 error format
1697 2 - v2 error format
1698
1699Returns:
1700 An object of the form:
1701
1702 { # Represents a single object that is an item in the search index, such as a
1703 # file, folder, or a database record.
1704 "status": { # This contains item's status and any errors. # Status of the item.
1705 # Output only field.
1706 "processingErrors": [ # Error details in case the item is in ERROR state.
1707 {
1708 "code": "A String", # Error code indicating the nature of the error.
1709 "errorMessage": "A String", # Description of the error.
1710 "fieldViolations": [ # In case the item fields are invalid, this field contains the details
1711 # about the validation errors.
1712 {
1713 "field": "A String", # Path of field with violation.
1714 "description": "A String", # Description of the error.
1715 },
1716 ],
1717 },
1718 ],
1719 "repositoryErrors": [ # Repository error reported by connector.
1720 { # Errors when the connector is communicating to the source repository.
1721 "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
1722 "errorMessage": "A String", # Message that describes the error. The maximum allowable length
1723 # of the message is 8192 characters.
1724 "type": "A String", # Type of error.
1725 },
1726 ],
1727 "code": "A String", # Status code.
1728 },
1729 "queue": "A String", # Queue this item belongs to.
1730 # The maximum length is 100 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1731 "itemType": "A String", # Type for this item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1732 "name": "A String", # Name of the Item. Format:
1733 # datasources/{source_id}/items/{item_id}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1734 # &lt;br /&gt;This is a required field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1735 # The maximum length is 1536 characters.
1736 "acl": { # Access control list information for the item. For more information see # Access control list for this item.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1737 # [Map ACLs](/cloud-search/docs/guides/acls).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1738 "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
1739 # parent. This should always be set in tandem with the
1740 # inheritAclFrom
1741 # field. Also, when the
1742 # inheritAclFrom field
1743 # is set, this field should be set to a valid AclInheritanceType.
1744 "readers": [ # List of principals who are allowed to see the item in search results.
1745 # Optional if inheriting permissions from another item or if the item
1746 # is not intended to be visible, such as
1747 # virtual
1748 # containers.
1749 # The maximum number of elements is 1000.
1750 { # Reference to a user, group, or domain.
1751 "userResourceName": "A String", # This principal is a user identified using an external identity.
1752 # The name field must specify the user resource name with this format:
1753 # identitysources/{source_id}/users/{ID}
1754 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1755 # The name field must specify the group resource name with this format:
1756 # identitysources/{source_id}/groups/{ID}
1757 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1758 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1759 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1760 # customer.
1761 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1762 },
1763 },
1764 ],
1765 "deniedReaders": [ # List of principals who are explicitly denied access to the item in search
1766 # results. While principals are denied access by default, use denied readers
1767 # to handle exceptions and override the list allowed readers.
1768 # The maximum number of elements is 100.
1769 { # Reference to a user, group, or domain.
1770 "userResourceName": "A String", # This principal is a user identified using an external identity.
1771 # The name field must specify the user resource name with this format:
1772 # identitysources/{source_id}/users/{ID}
1773 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1774 # The name field must specify the group resource name with this format:
1775 # identitysources/{source_id}/groups/{ID}
1776 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1777 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1778 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1779 # customer.
1780 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1781 },
1782 },
1783 ],
1784 "owners": [ # Optional. List of owners for the item. This field has no bearing on
1785 # document access permissions. It does, however, offer
1786 # a slight ranking boosts items where the querying user is an owner.
1787 # The maximum number of elements is 5.
1788 { # Reference to a user, group, or domain.
1789 "userResourceName": "A String", # This principal is a user identified using an external identity.
1790 # The name field must specify the user resource name with this format:
1791 # identitysources/{source_id}/users/{ID}
1792 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1793 # The name field must specify the group resource name with this format:
1794 # identitysources/{source_id}/groups/{ID}
1795 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1796 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1797 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1798 # customer.
1799 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1800 },
1801 },
1802 ],
1803 "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
1804 # Note: ACL inheritance *only* provides access permissions
1805 # to child items and does not define structural relationships, nor does it
1806 # provide convenient ways to delete large groups of items.
1807 # Deleting an ACL parent from the index only alters the access permissions of
1808 # child items that reference the parent in the
1809 # inheritAclFrom
1810 # field. The item is still in the index, but may not
1811 # visible in search results. By contrast, deletion of a container item
1812 # also deletes all items that reference the container via the
1813 # containerName
1814 # field.
1815 # The maximum length for this field is 1536 characters.
1816 },
1817 "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
1818 "contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
1819 # This reference is created via upload
1820 # method.
1821 # Updating of item content may refer to this uploaded content via
1822 # contentDataRef.
1823 "name": "A String", # Name of the content reference.
1824 # The maximum length is 2048 characters.
1825 },
1826 "contentFormat": "A String",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1827 "inlineContent": "A String", # Content that is supplied inlined within the update method.
1828 # The maximum length is 102400 bytes (100 KiB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1829 "hash": "A String", # Hashing info calculated and provided by the API client for content.
1830 # Can be used with the items.push method to calculate modified state.
1831 # The maximum length is 2048 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1832 },
1833 "version": "A String", # Required. The indexing system stores the version from the datasource as a
1834 # byte string and compares the Item version in the index
1835 # to the version of the queued Item using lexical ordering.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1836 # &lt;br /&gt;&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1837 # Cloud Search Indexing won't index or delete any queued item with
1838 # a version value that is less than or equal to the version of the
1839 # currently indexed item.
1840 # The maximum length for this field is 1024 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1841 "structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
1842 # object definition in the schema for the data source.
1843 "object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
1844 # definition in the schema for the data source.
1845 "properties": [ # The properties for the object.
1846 # The maximum number of elements is 1000.
1847 { # A typed name-value pair for structured data. The type of the value should
1848 # be the same as the registered type for the `name` property in the object
1849 # definition of `objectType`.
1850 "objectValues": { # List of object values.
1851 "values": [
1852 # Object with schema name: StructuredDataObject
1853 ],
1854 },
1855 "dateValues": { # List of date values.
1856 "values": [
1857 { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1858 "year": 42, # Year of date. Must be from 1 to 9999.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1859 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
1860 "month": 42, # Month of date. Must be from 1 to 12.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1861 },
1862 ],
1863 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1864 "name": "A String", # The name of the property. This name should correspond to the name of the
1865 # property that was registered for object definition in the schema.
1866 # The maximum allowable length for this property is 256 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1867 "enumValues": { # List of enum values.
1868 "values": [ # The maximum allowable length for string values is 32 characters.
1869 "A String",
1870 ],
1871 },
1872 "integerValues": { # List of integer values.
1873 "values": [
1874 "A String",
1875 ],
1876 },
1877 "doubleValues": { # List of double values.
1878 "values": [
1879 3.14,
1880 ],
1881 },
1882 "htmlValues": { # List of html values.
1883 "values": [ # The maximum allowable length for html values is 2048 characters.
1884 "A String",
1885 ],
1886 },
1887 "booleanValue": True or False,
1888 "timestampValues": { # List of timestamp values.
1889 "values": [
1890 "A String",
1891 ],
1892 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1893 "textValues": { # List of text values.
1894 "values": [ # The maximum allowable length for text values is 2048 characters.
1895 "A String",
1896 ],
1897 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1898 },
1899 ],
1900 },
1901 "hash": "A String", # Hashing value provided by the API caller.
1902 # This can be used with the
1903 # items.push
1904 # method to calculate modified state.
1905 # The maximum length is 2048 characters.
1906 },
1907 "payload": "A String", # Additional state connector can store for this item.
1908 # The maximum length is 10000 bytes.
1909 "metadata": { # Available metadata fields for the item. # Metadata information.
1910 "mimeType": "A String", # The original mime-type of
1911 # ItemContent.content
1912 # in the source repository.
1913 # The maximum length is 256 characters.
1914 "containerName": "A String", # The name of the container for this item.
1915 # Deletion of the container item leads to automatic deletion of this
1916 # item. Note: ACLs are not inherited from a container item.
1917 # To provide ACL inheritance for an item, use the
1918 # inheritAclFrom
1919 # field. The maximum length is 1536 characters.
1920 "updateTime": "A String", # The time when the item was last modified in the source repository.
1921 "hash": "A String", # Hashing value provided by the API caller.
1922 # This can be used with the
1923 # items.push
1924 # method to calculate modified state.
1925 # The maximum length is 2048 characters.
1926 "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For
1927 # more information, see
1928 # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
1929 # The maximum length is 32 characters.
1930 "title": "A String", # The title of the item. If given, this will be the displayed title of the
1931 # Search result.
1932 # The maximum length is 2048 characters.
1933 "interactions": [ # A list of interactions for the item. Interactions are used to improve
1934 # Search quality, but are not exposed to end users.
1935 # The maximum number of elements is 1000.
1936 { # Represents an interaction between a user and an item.
1937 "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same
1938 # type exist for a single user, only the most recent action is recorded.
1939 "type": "A String",
1940 "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
1941 "userResourceName": "A String", # This principal is a user identified using an external identity.
1942 # The name field must specify the user resource name with this format:
1943 # identitysources/{source_id}/users/{ID}
1944 "groupResourceName": "A String", # This principal is a group identified using an external identity.
1945 # The name field must specify the group resource name with this format:
1946 # identitysources/{source_id}/groups/{ID}
1947 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
1948 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
1949 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
1950 # customer.
1951 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
1952 },
1953 },
1954 },
1955 ],
1956 "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
1957 "quality": 3.14, # An indication of the quality of the item, used to influence search quality.
1958 # Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The
1959 # default value is 0.0.
1960 },
1961 "keywords": [ # Additional keywords or phrases that should match the item.
1962 # Used internally for user generated content.
1963 # The maximum number of elements is 100.
1964 # The maximum length is 8192 characters.
1965 "A String",
1966 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1967 "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &amp;#83;earch results apply
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1968 # this link to the title.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1969 # Whitespace or special characters may cause Cloud &amp;#83;earch result links to
1970 # trigger a redirect notice; to avoid this, encode the URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1971 # The maximum length is 2048 characters.
1972 "createTime": "A String", # The time when the item was created in the source repository.
1973 "objectType": "A String", # The type of the item. This should correspond to the name of an object
1974 # definition in the schema registered for the data source. For example, if
1975 # the schema for the data source contains an object definition with name
1976 # 'document', then item indexing requests for objects of that type should set
1977 # objectType to 'document'.
1978 # The maximum length is 256 characters.
1979 },
1980 }</pre>
1981</div>
1982
1983<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1984 <code class="details" id="unreserve">unreserve(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1985 <pre>Unreserves all items from a queue, making them all eligible to be
1986polled. This method is useful for resetting the indexing queue
1987after a connector has been restarted.
1988
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1989This API requires an admin or service account to execute. The service
1990account used is the one whitelisted in the corresponding data source.
1991
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1992Args:
1993 name: string, Name of the Data Source to unreserve all items.
1994Format: datasources/{source_id} (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1995 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1996 The object takes the form of:
1997
1998{
1999 "queue": "A String", # Name of a queue to unreserve items from.
2000 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
2001 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
2002 # Otherwise, ignore this field.
2003 },
2004 "connectorName": "A String", # Name of connector making this call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2005 # &lt;br /&gt;Format: datasources/{source_id}/connectors/{ID}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2006 }
2007
2008 x__xgafv: string, V1 error format.
2009 Allowed values
2010 1 - v1 error format
2011 2 - v2 error format
2012
2013Returns:
2014 An object of the form:
2015
2016 { # This resource represents a long-running operation that is the result of a
2017 # network API call.
2018 "metadata": { # Service-specific metadata associated with the operation. It typically
2019 # contains progress information and common metadata such as create time.
2020 # Some services might not provide such metadata. Any method that returns a
2021 # long-running operation should document the metadata type, if any.
2022 "a_key": "", # Properties of the object. Contains field @type with type URL.
2023 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2024 "done": True or False, # If the value is `false`, it means the operation is still in progress.
2025 # If `true`, the operation is completed, and either `error` or `response` is
2026 # available.
2027 "response": { # The normal response of the operation in case of success. If the original
2028 # method returns no data on success, such as `Delete`, the response is
2029 # `google.protobuf.Empty`. If the original method is standard
2030 # `Get`/`Create`/`Update`, the response should be the resource. For other
2031 # methods, the response should have the type `XxxResponse`, where `Xxx`
2032 # is the original method name. For example, if the original method name
2033 # is `TakeSnapshot()`, the inferred response type is
2034 # `TakeSnapshotResponse`.
2035 "a_key": "", # Properties of the object. Contains field @type with type URL.
2036 },
2037 "name": "A String", # The server-assigned name, which is only unique within the same service that
2038 # originally returns it. If you use the default HTTP mapping, the
2039 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2040 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
2041 # different programming environments, including REST APIs and RPC APIs. It is
2042 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2043 # three pieces of data: error code, error message, and error details.
2044 #
2045 # You can find out more about this error model and how to work with it in the
2046 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2047 "message": "A String", # A developer-facing error message, which should be in English. Any
2048 # user-facing error message should be localized and sent in the
2049 # google.rpc.Status.details field, or localized by the client.
2050 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
2051 "details": [ # A list of messages that carry the error details. There is a common set of
2052 # message types for APIs to use.
2053 {
2054 "a_key": "", # Properties of the object. Contains field @type with type URL.
2055 },
2056 ],
2057 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2058 }</pre>
2059</div>
2060
2061<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2062 <code class="details" id="upload">upload(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2063 <pre>Creates an upload session for uploading item content. For items smaller
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2064than 100 KB, it's easier to embed the content
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2065inline within
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2066an index request.
2067
2068This API requires an admin or service account to execute. The service
2069account used is the one whitelisted in the corresponding data source.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2070
2071Args:
2072 name: string, Name of the Item to start a resumable upload.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2073Format: datasources/{source_id}/items/{item_id}.
2074The maximum length is 1536 bytes. (required)
2075 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2076 The object takes the form of:
2077
2078{ # Start upload file request.
2079 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
2080 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
2081 # Otherwise, ignore this field.
2082 },
2083 "connectorName": "A String", # Name of connector making this call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2084 # &lt;br /&gt;Format: datasources/{source_id}/connectors/{ID}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2085 }
2086
2087 x__xgafv: string, V1 error format.
2088 Allowed values
2089 1 - v1 error format
2090 2 - v2 error format
2091
2092Returns:
2093 An object of the form:
2094
2095 { # Represents an upload session reference.
2096 # This reference is created via upload
2097 # method.
2098 # Updating of item content may refer to this uploaded content via
2099 # contentDataRef.
2100 "name": "A String", # Name of the content reference.
2101 # The maximum length is 2048 characters.
2102 }</pre>
2103</div>
2104
2105</body></html>