Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / cloudsearch_v1.debug.datasources.items.html
blob: b9d3d98ceb3d399dc87ba967955df720a60353a8 [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.debug.html">debug</a> . <a href="cloudsearch_v1.debug.datasources.html">datasources</a> . <a href="cloudsearch_v1.debug.datasources.items.html">items</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudsearch_v1.debug.datasources.items.unmappedids.html">unmappedids()</a></code>
79</p>
80<p class="firstline">Returns the unmappedids Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#checkAccess">checkAccess(name, body=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Checks whether an item is accessible by specified principal.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86 <code><a href="#searchByViewUrl">searchByViewUrl(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87<p class="firstline">Fetches the item whose viewUrl exactly matches that of the URL provided</p>
88<p class="toc_element">
89 <code><a href="#searchByViewUrl_next">searchByViewUrl_next(previous_request, previous_response)</a></code></p>
90<p class="firstline">Retrieves the next page of results.</p>
91<h3>Method Details</h3>
92<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code class="details" id="checkAccess">checkAccess(name, body=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94 <pre>Checks whether an item is accessible by specified principal.
95
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96**Note:** This API requires an admin account to execute.
97
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98Args:
99 name: string, Item name, format:
100datasources/{source_id}/items/{item_id} (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102 The object takes the form of:
103
104{ # Reference to a user, group, or domain.
105 "userResourceName": "A String", # This principal is a user identified using an external identity.
106 # The name field must specify the user resource name with this format:
107 # identitysources/{source_id}/users/{ID}
108 "groupResourceName": "A String", # This principal is a group identified using an external identity.
109 # The name field must specify the group resource name with this format:
110 # identitysources/{source_id}/groups/{ID}
111 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
112 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
113 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
114 # customer.
115 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
116 },
117}
118
119 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
120Otherwise, ignore this field.
121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126Returns:
127 An object of the form:
128
129 {
130 "hasAccess": True or False, # Returns true if principal has access. Returns false otherwise.
131 }</pre>
132</div>
133
134<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]135 <code class="details" id="searchByViewUrl">searchByViewUrl(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 <pre>Fetches the item whose viewUrl exactly matches that of the URL provided
137in the request.
138
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139**Note:** This API requires an admin account to execute.
140
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141Args:
142 name: string, Source name, format:
143datasources/{source_id} (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]144 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 The object takes the form of:
146
147{
148 "pageToken": "A String", # The next_page_token value returned from a previous request, if any.
149 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
150 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
151 # Otherwise, ignore this field.
152 },
153 "viewUrl": "A String", # Specify the full view URL to find the corresponding item.
154 # The maximum length is 2048 characters.
155 }
156
157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162Returns:
163 An object of the form:
164
165 {
166 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
167 # more results in the list.
168 "items": [
169 { # Represents a single object that is an item in the search index, such as a
170 # file, folder, or a database record.
171 "status": { # This contains item's status and any errors. # Status of the item.
172 # Output only field.
173 "processingErrors": [ # Error details in case the item is in ERROR state.
174 {
175 "code": "A String", # Error code indicating the nature of the error.
176 "errorMessage": "A String", # Description of the error.
177 "fieldViolations": [ # In case the item fields are invalid, this field contains the details
178 # about the validation errors.
179 {
180 "field": "A String", # Path of field with violation.
181 "description": "A String", # Description of the error.
182 },
183 ],
184 },
185 ],
186 "repositoryErrors": [ # Repository error reported by connector.
187 { # Errors when the connector is communicating to the source repository.
188 "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
189 "errorMessage": "A String", # Message that describes the error. The maximum allowable length
190 # of the message is 8192 characters.
191 "type": "A String", # Type of error.
192 },
193 ],
194 "code": "A String", # Status code.
195 },
196 "queue": "A String", # Queue this item belongs to.
197 # The maximum length is 100 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]198 "itemType": "A String", # Type for this item.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199 "name": "A String", # Name of the Item. Format:
200 # datasources/{source_id}/items/{item_id}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]201 # &lt;br /&gt;This is a required field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 # The maximum length is 1536 characters.
203 "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]204 # [Map ACLs](/cloud-search/docs/guides/acls).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
206 # parent. This should always be set in tandem with the
207 # inheritAclFrom
208 # field. Also, when the
209 # inheritAclFrom field
210 # is set, this field should be set to a valid AclInheritanceType.
211 "readers": [ # List of principals who are allowed to see the item in search results.
212 # Optional if inheriting permissions from another item or if the item
213 # is not intended to be visible, such as
214 # virtual
215 # containers.
216 # The maximum number of elements is 1000.
217 { # Reference to a user, group, or domain.
218 "userResourceName": "A String", # This principal is a user identified using an external identity.
219 # The name field must specify the user resource name with this format:
220 # identitysources/{source_id}/users/{ID}
221 "groupResourceName": "A String", # This principal is a group identified using an external identity.
222 # The name field must specify the group resource name with this format:
223 # identitysources/{source_id}/groups/{ID}
224 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
225 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
226 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
227 # customer.
228 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
229 },
230 },
231 ],
232 "deniedReaders": [ # List of principals who are explicitly denied access to the item in search
233 # results. While principals are denied access by default, use denied readers
234 # to handle exceptions and override the list allowed readers.
235 # The maximum number of elements is 100.
236 { # Reference to a user, group, or domain.
237 "userResourceName": "A String", # This principal is a user identified using an external identity.
238 # The name field must specify the user resource name with this format:
239 # identitysources/{source_id}/users/{ID}
240 "groupResourceName": "A String", # This principal is a group identified using an external identity.
241 # The name field must specify the group resource name with this format:
242 # identitysources/{source_id}/groups/{ID}
243 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
244 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
245 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
246 # customer.
247 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
248 },
249 },
250 ],
251 "owners": [ # Optional. List of owners for the item. This field has no bearing on
252 # document access permissions. It does, however, offer
253 # a slight ranking boosts items where the querying user is an owner.
254 # The maximum number of elements is 5.
255 { # Reference to a user, group, or domain.
256 "userResourceName": "A String", # This principal is a user identified using an external identity.
257 # The name field must specify the user resource name with this format:
258 # identitysources/{source_id}/users/{ID}
259 "groupResourceName": "A String", # This principal is a group identified using an external identity.
260 # The name field must specify the group resource name with this format:
261 # identitysources/{source_id}/groups/{ID}
262 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
263 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
264 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
265 # customer.
266 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
267 },
268 },
269 ],
270 "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
271 # Note: ACL inheritance *only* provides access permissions
272 # to child items and does not define structural relationships, nor does it
273 # provide convenient ways to delete large groups of items.
274 # Deleting an ACL parent from the index only alters the access permissions of
275 # child items that reference the parent in the
276 # inheritAclFrom
277 # field. The item is still in the index, but may not
278 # visible in search results. By contrast, deletion of a container item
279 # also deletes all items that reference the container via the
280 # containerName
281 # field.
282 # The maximum length for this field is 1536 characters.
283 },
284 "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
285 "contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
286 # This reference is created via upload
287 # method.
288 # Updating of item content may refer to this uploaded content via
289 # contentDataRef.
290 "name": "A String", # Name of the content reference.
291 # The maximum length is 2048 characters.
292 },
293 "contentFormat": "A String",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]294 "inlineContent": "A String", # Content that is supplied inlined within the update method.
295 # The maximum length is 102400 bytes (100 KiB).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296 "hash": "A String", # Hashing info calculated and provided by the API client for content.
297 # Can be used with the items.push method to calculate modified state.
298 # The maximum length is 2048 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 },
300 "version": "A String", # Required. The indexing system stores the version from the datasource as a
301 # byte string and compares the Item version in the index
302 # to the version of the queued Item using lexical ordering.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]303 # &lt;br /&gt;&lt;br /&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304 # Cloud Search Indexing won't index or delete any queued item with
305 # a version value that is less than or equal to the version of the
306 # currently indexed item.
307 # The maximum length for this field is 1024 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 "structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
309 # object definition in the schema for the data source.
310 "object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
311 # definition in the schema for the data source.
312 "properties": [ # The properties for the object.
313 # The maximum number of elements is 1000.
314 { # A typed name-value pair for structured data. The type of the value should
315 # be the same as the registered type for the `name` property in the object
316 # definition of `objectType`.
317 "objectValues": { # List of object values.
318 "values": [
319 # Object with schema name: StructuredDataObject
320 ],
321 },
322 "dateValues": { # List of date values.
323 "values": [
324 { # 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]325 "year": 42, # Year of date. Must be from 1 to 9999.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]326 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
327 "month": 42, # Month of date. Must be from 1 to 12.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 },
329 ],
330 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]331 "name": "A String", # The name of the property. This name should correspond to the name of the
332 # property that was registered for object definition in the schema.
333 # The maximum allowable length for this property is 256 characters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 "enumValues": { # List of enum values.
335 "values": [ # The maximum allowable length for string values is 32 characters.
336 "A String",
337 ],
338 },
339 "integerValues": { # List of integer values.
340 "values": [
341 "A String",
342 ],
343 },
344 "doubleValues": { # List of double values.
345 "values": [
346 3.14,
347 ],
348 },
349 "htmlValues": { # List of html values.
350 "values": [ # The maximum allowable length for html values is 2048 characters.
351 "A String",
352 ],
353 },
354 "booleanValue": True or False,
355 "timestampValues": { # List of timestamp values.
356 "values": [
357 "A String",
358 ],
359 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]360 "textValues": { # List of text values.
361 "values": [ # The maximum allowable length for text values is 2048 characters.
362 "A String",
363 ],
364 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 },
366 ],
367 },
368 "hash": "A String", # Hashing value provided by the API caller.
369 # This can be used with the
370 # items.push
371 # method to calculate modified state.
372 # The maximum length is 2048 characters.
373 },
374 "payload": "A String", # Additional state connector can store for this item.
375 # The maximum length is 10000 bytes.
376 "metadata": { # Available metadata fields for the item. # Metadata information.
377 "mimeType": "A String", # The original mime-type of
378 # ItemContent.content
379 # in the source repository.
380 # The maximum length is 256 characters.
381 "containerName": "A String", # The name of the container for this item.
382 # Deletion of the container item leads to automatic deletion of this
383 # item. Note: ACLs are not inherited from a container item.
384 # To provide ACL inheritance for an item, use the
385 # inheritAclFrom
386 # field. The maximum length is 1536 characters.
387 "updateTime": "A String", # The time when the item was last modified in the source repository.
388 "hash": "A String", # Hashing value provided by the API caller.
389 # This can be used with the
390 # items.push
391 # method to calculate modified state.
392 # The maximum length is 2048 characters.
393 "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For
394 # more information, see
395 # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
396 # The maximum length is 32 characters.
397 "title": "A String", # The title of the item. If given, this will be the displayed title of the
398 # Search result.
399 # The maximum length is 2048 characters.
400 "interactions": [ # A list of interactions for the item. Interactions are used to improve
401 # Search quality, but are not exposed to end users.
402 # The maximum number of elements is 1000.
403 { # Represents an interaction between a user and an item.
404 "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same
405 # type exist for a single user, only the most recent action is recorded.
406 "type": "A String",
407 "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
408 "userResourceName": "A String", # This principal is a user identified using an external identity.
409 # The name field must specify the user resource name with this format:
410 # identitysources/{source_id}/users/{ID}
411 "groupResourceName": "A String", # This principal is a group identified using an external identity.
412 # The name field must specify the group resource name with this format:
413 # identitysources/{source_id}/groups/{ID}
414 "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
415 "gsuiteUserEmail": "A String", # This principal references a G Suite user account
416 "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
417 # customer.
418 "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
419 },
420 },
421 },
422 ],
423 "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
424 "quality": 3.14, # An indication of the quality of the item, used to influence search quality.
425 # Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The
426 # default value is 0.0.
427 },
428 "keywords": [ # Additional keywords or phrases that should match the item.
429 # Used internally for user generated content.
430 # The maximum number of elements is 100.
431 # The maximum length is 8192 characters.
432 "A String",
433 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]434 "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]435 # this link to the title.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]436 # Whitespace or special characters may cause Cloud &amp;#83;earch result links to
437 # trigger a redirect notice; to avoid this, encode the URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 # The maximum length is 2048 characters.
439 "createTime": "A String", # The time when the item was created in the source repository.
440 "objectType": "A String", # The type of the item. This should correspond to the name of an object
441 # definition in the schema registered for the data source. For example, if
442 # the schema for the data source contains an object definition with name
443 # 'document', then item indexing requests for objects of that type should set
444 # objectType to 'document'.
445 # The maximum length is 256 characters.
446 },
447 },
448 ],
449 }</pre>
450</div>
451
452<div class="method">
453 <code class="details" id="searchByViewUrl_next">searchByViewUrl_next(previous_request, previous_response)</code>
454 <pre>Retrieves the next page of results.
455
456Args:
457 previous_request: The request for the previous page. (required)
458 previous_response: The response from the request for the previous page. (required)
459
460Returns:
461 A request object that you can call 'execute()' on to request the next
462 page. Returns None if there are no more items in the collection.
463 </pre>
464</div>
465
466</body></html>