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