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