1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.indexing.html">indexing</a> . <a href="cloudsearch_v1.indexing.datasources.html">datasources</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="cloudsearch_v1.indexing.datasources.items.html">items()</a></code> 79</p> 80<p class="firstline">Returns the items Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#deleteSchema">deleteSchema(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p> 84<p class="firstline">Deletes the schema of a data source.</p> 85<p class="toc_element"> 86 <code><a href="#getSchema">getSchema(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Gets the schema of a data source.</p> 88<p class="toc_element"> 89 <code><a href="#updateSchema">updateSchema(name, body, x__xgafv=None)</a></code></p> 90<p class="firstline">Updates the schema of a data source.</p> 91<h3>Method Details</h3> 92<div class="method"> 93 <code class="details" id="deleteSchema">deleteSchema(name, debugOptions_enableDebugging=None, x__xgafv=None)</code> 94 <pre>Deletes the schema of a data source. 95 96Args: 97 name: string, Name of the data source to delete Schema. Format: 98datasources/{source_id} (required) 99 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. 100Otherwise, ignore this field. 101 x__xgafv: string, V1 error format. 102 Allowed values 103 1 - v1 error format 104 2 - v2 error format 105 106Returns: 107 An object of the form: 108 109 { # This resource represents a long-running operation that is the result of a 110 # network API call. 111 "metadata": { # Service-specific metadata associated with the operation. It typically 112 # contains progress information and common metadata such as create time. 113 # Some services might not provide such metadata. Any method that returns a 114 # long-running operation should document the metadata type, if any. 115 "a_key": "", # Properties of the object. Contains field @type with type URL. 116 }, 117 "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. 118 # different programming environments, including REST APIs and RPC APIs. It is 119 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 120 # three pieces of data: error code, error message, and error details. 121 # 122 # You can find out more about this error model and how to work with it in the 123 # [API Design Guide](https://cloud.google.com/apis/design/errors). 124 "message": "A String", # A developer-facing error message, which should be in English. Any 125 # user-facing error message should be localized and sent in the 126 # google.rpc.Status.details field, or localized by the client. 127 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 128 "details": [ # A list of messages that carry the error details. There is a common set of 129 # message types for APIs to use. 130 { 131 "a_key": "", # Properties of the object. Contains field @type with type URL. 132 }, 133 ], 134 }, 135 "done": True or False, # If the value is `false`, it means the operation is still in progress. 136 # If `true`, the operation is completed, and either `error` or `response` is 137 # available. 138 "response": { # The normal response of the operation in case of success. If the original 139 # method returns no data on success, such as `Delete`, the response is 140 # `google.protobuf.Empty`. If the original method is standard 141 # `Get`/`Create`/`Update`, the response should be the resource. For other 142 # methods, the response should have the type `XxxResponse`, where `Xxx` 143 # is the original method name. For example, if the original method name 144 # is `TakeSnapshot()`, the inferred response type is 145 # `TakeSnapshotResponse`. 146 "a_key": "", # Properties of the object. Contains field @type with type URL. 147 }, 148 "name": "A String", # The server-assigned name, which is only unique within the same service that 149 # originally returns it. If you use the default HTTP mapping, the 150 # `name` should be a resource name ending with `operations/{unique_id}`. 151 }</pre> 152</div> 153 154<div class="method"> 155 <code class="details" id="getSchema">getSchema(name, debugOptions_enableDebugging=None, x__xgafv=None)</code> 156 <pre>Gets the schema of a data source. 157 158Args: 159 name: string, Name of the data source to get Schema. Format: 160datasources/{source_id} (required) 161 debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. 162Otherwise, ignore this field. 163 x__xgafv: string, V1 error format. 164 Allowed values 165 1 - v1 error format 166 2 - v2 error format 167 168Returns: 169 An object of the form: 170 171 { # The schema definition for a data source. 172 "objectDefinitions": [ # The list of top-level objects for the data source. 173 # The maximum number of elements is 10. 174 { # The definition for an object within a data source. 175 "propertyDefinitions": [ # The property definitions for the object. 176 # The maximum number of elements is 1000. 177 { # The definition of a property within an object. 178 "htmlPropertyOptions": { # Options for html properties. 179 "retrievalImportance": { # Indicates the search quality importance of the tokens within the 180 # field when used for retrieval. Can only be set to DEFAULT or NONE. 181 "importance": "A String", # Indicates the ranking importance given to property when it is matched 182 # during retrieval. Once set, the token importance of a property cannot be 183 # changed. 184 }, 185 "operatorOptions": { # Used to provide a search operator for html properties. This is optional. # If set, describes how the property should be used as a search operator. 186 # Search operators let users restrict the query to specific fields relevant 187 # to the type of item being searched. 188 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 189 # html property. For example, if operatorName is *subject* and the 190 # property's name is *subjectLine*, then queries like 191 # *subject:<value>* will show results only where the value of the 192 # property named *subjectLine* matches *<value>*. By contrast, a 193 # search that uses the same *<value>* without an operator will return 194 # all items where *<value>* matches the value of any 195 # html properties or text within the content field for the item. 196 # The operator name can only contain lowercase letters (a-z). 197 # The maximum length is 32 characters. 198 }, 199 }, 200 "textPropertyOptions": { # Options for text properties. 201 "retrievalImportance": { # Indicates the search quality importance of the tokens within the 202 # field when used for retrieval. 203 "importance": "A String", # Indicates the ranking importance given to property when it is matched 204 # during retrieval. Once set, the token importance of a property cannot be 205 # changed. 206 }, 207 "operatorOptions": { # Used to provide a search operator for text properties. This is optional. # If set, describes how the property should be used as a search operator. 208 # Search operators let users restrict the query to specific fields relevant 209 # to the type of item being searched. 210 "exactMatchWithOperator": True or False, # If true, the text value will be tokenized as one atomic value in 211 # operator searches and facet matches. For example, if the operator name is 212 # "genre" and the value is "science-fiction" the query restrictions 213 # "genre:science" and "genre:fiction" will not match the item; 214 # "genre:science-fiction" will. Value matching is case-sensitive 215 # and does not remove special characters. 216 # If false, the text will be tokenized. For example, if the value is 217 # "science-fiction" the queries "genre:science" and "genre:fiction" will 218 # match the item. 219 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 220 # text property. For example, if operatorName is *subject* and the 221 # property's name is *subjectLine*, then queries like 222 # *subject:<value>* will show results only where the value of the 223 # property named *subjectLine* matches *<value>*. By contrast, a 224 # search that uses the same *<value>* without an operator will return 225 # all items where *<value>* matches the value of any 226 # text properties or text within the content field for the item. 227 # The operator name can only contain lowercase letters (a-z). 228 # The maximum length is 32 characters. 229 }, 230 }, 231 "name": "A String", # The name of the property. Item indexing requests sent to the Indexing API 232 # should set the property name 233 # equal to this value. For example, if name is *subject_line*, then indexing 234 # requests for document items with subject fields should set the 235 # name for that field equal to 236 # *subject_line*. Use the name as the identifier for the object property. 237 # Once registered as a property for an object, you cannot re-use this name 238 # for another property within that object. 239 # The name must start with a letter and can only contain letters (A-Z, a-z) 240 # or numbers (0-9). 241 # The maximum length is 256 characters. 242 "enumPropertyOptions": { # Options for enum properties, which allow you to define a restricted set of 243 # strings to match user queries, set rankings for those string values, and 244 # define an operator name to be paired with those strings so that users can 245 # narrow results to only items with a specific value. For example, for items in 246 # a request tracking system with priority information, you could define *p0* as 247 # an allowable enum value and tie this enum to the operator name *priority* so 248 # that search users could add *priority:p0* to their query to restrict the set 249 # of results to only those items indexed with the value *p0*. 250 "orderedRanking": "A String", # Used to specify the ordered ranking for the enumeration that determines how 251 # the integer values provided in the possible EnumValuePairs are used to rank 252 # results. If specified, integer values must be provided for all possible 253 # EnumValuePair values given for this property. Can only be used if 254 # isRepeatable 255 # is false. 256 "operatorOptions": { # Used to provide a search operator for enum properties. This is # If set, describes how the enum should be used as a search operator. 257 # optional. Search operators let users restrict the query to specific fields 258 # relevant to the type of item being searched. For example, if you provide no 259 # operator for a *priority* enum property with possible values *p0* and *p1*, 260 # a query that contains the term *p0* will return items that have *p0* as the 261 # value of the *priority* property, as well as any items that contain the 262 # string *p0* in other fields. If you provide an operator name for the enum, 263 # such as *priority*, then search users can use that operator to refine 264 # results to only items that have *p0* as this property's value, with the 265 # query *priority:p0*. 266 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 267 # enum property. For example, if operatorName is *priority* and the 268 # property's name is *priorityVal*, then queries like 269 # *priority:<value>* will show results only where the value of the 270 # property named *priorityVal* matches *<value>*. By contrast, a 271 # search that uses the same *<value>* without an operator will return 272 # all items where *<value>* matches the value of any String 273 # properties or text within the content field for the item. 274 # The operator name can only contain lowercase letters (a-z). 275 # The maximum length is 32 characters. 276 }, 277 "possibleValues": [ # The list of possible values for the enumeration property. All 278 # EnumValuePairs must provide a string value. If you specify an integer value 279 # for one EnumValuePair, then all possible EnumValuePairs must provide an 280 # integer value. Both the string value and integer value must be unique over 281 # all possible values. Once set, possible values cannot be removed or 282 # modified. If you supply an ordered ranking and think you might insert 283 # additional enum values in the future, leave gaps in the initial integer 284 # values to allow adding a value in between previously registered values. 285 # The maximum number of elements is 100. 286 { # The enumeration value pair defines two things: a required string value and 287 # an optional integer value. The string value defines the necessary query 288 # term required to retrieve that item, such as *p0* for a priority item. 289 # The integer value determines the ranking of that string value relative 290 # to other enumerated values for the same property. For example, you might 291 # associate *p0* with *0* and define another enum pair such as *p1* and *1*. 292 # You must use the integer value in combination with 293 # ordered 294 # ranking to 295 # set the ranking of a given value relative to other enumerated values for 296 # the same property name. Here, a ranking order of DESCENDING for *priority* 297 # properties results in a ranking boost for items indexed with a value of 298 # *p0* compared to items indexed with a value of *p1*. Without a specified 299 # ranking order, the integer value has no effect on item ranking. 300 "stringValue": "A String", # The string value of the EnumValuePair. 301 # The maximum length is 32 characters. 302 "integerValue": 42, # The integer value of the EnumValuePair which must be non-negative. 303 # Optional. 304 }, 305 ], 306 }, 307 "isReturnable": True or False, # Indicates that the property identifies data that should be returned in 308 # search results via the Query API. If set to *true*, indicates that Query 309 # API users can use matching property fields in results. However, storing 310 # fields requires more space allocation and uses more bandwidth for search 311 # queries, which impacts performance over large datasets. Set to *true* here 312 # only if the field is needed for search results. Cannot be true for 313 # properties whose type is an object. 314 "isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for 315 # properties that are repeatable. Cannot be true for properties whose type 316 # is object or user identifier. IsReturnable must be true to set this option. 317 # Only supported for Boolean, Date, Double, Integer, and Timestamp 318 # properties. 319 "objectPropertyOptions": { # Options for object properties. 320 "subobjectProperties": [ # The properties of the sub-object. These properties represent a nested 321 # object. For example, if this property represents a postal address, the 322 # subobjectProperties might be named *street*, *city*, and *state*. 323 # The maximum number of elements is 1000. 324 # Object with schema name: PropertyDefinition 325 ], 326 }, 327 "timestampPropertyOptions": { # Options for timestamp properties. 328 "operatorOptions": { # Used to provide a search operator for timestamp properties. This is # If set, describes how the timestamp should be used as a search operator. 329 # optional. Search operators let users restrict the query to specific fields 330 # relevant to the type of item being searched. 331 "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 332 # timestamp property using the less-than operator. For example, if 333 # lessThanOperatorName is *closedbefore* and the property's name is 334 # *closeDate*, then queries like *closedbefore:<value>* will 335 # show results only where the value of the property named *closeDate* is 336 # earlier than *<value>*. 337 # The operator name can only contain lowercase letters (a-z). 338 # The maximum length is 32 characters. 339 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 340 # timestamp property. For example, if operatorName is *closedon* and the 341 # property's name is *closeDate*, then queries like 342 # *closedon:<value>* will show results only where the value of the 343 # property named *closeDate* matches *<value>*. By contrast, a 344 # search that uses the same *<value>* without an operator will return 345 # all items where *<value>* matches the value of any String 346 # properties or text within the content field for the item. The operator 347 # name can only contain lowercase letters (a-z). The maximum length is 32 348 # characters. 349 "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 350 # timestamp property using the greater-than operator. For example, if 351 # greaterThanOperatorName is *closedafter* and the property's name is 352 # *closeDate*, then queries like *closedafter:<value>* will 353 # show results only where the value of the property named *closeDate* is 354 # later than *<value>*. 355 # The operator name can only contain lowercase letters (a-z). 356 # The maximum length is 32 characters. 357 }, 358 }, 359 "datePropertyOptions": { # Options for date properties. 360 "operatorOptions": { # Optional. Provides a search operator for date properties. # If set, describes how the date should be used as a search operator. 361 # Search operators let users restrict the query to specific fields relevant 362 # to the type of item being searched. 363 "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 364 # date property using the less-than operator. For example, if 365 # lessThanOperatorName is *closedbefore* and the property's name is 366 # *closeDate*, then queries like *closedbefore:<value>* will 367 # show results only where the value of the property named *closeDate* is 368 # earlier than *<value>*. 369 # The operator name can only contain lowercase letters (a-z). 370 # The maximum length is 32 characters. 371 "operatorName": "A String", # Indicates the actual string required in the query in order to isolate the 372 # date property. For example, suppose an issue tracking schema object 373 # has a property named *closeDate* that specifies an operator with an 374 # operatorName of *closedon*. For searches on that data, queries like 375 # *closedon:<value>* will show results only where the value of the 376 # *closeDate* property matches *<value>*. By contrast, a 377 # search that uses the same *<value>* without an operator will return 378 # all items where *<value>* matches the value of any String 379 # properties or text within the content field for the indexed datasource. 380 # The operator name can only contain lowercase letters (a-z). 381 # The maximum length is 32 characters. 382 "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 383 # date property using the greater-than operator. For example, if 384 # greaterThanOperatorName is *closedafter* and the property's name is 385 # *closeDate*, then queries like *closedafter:<value>* will 386 # show results only where the value of the property named *closeDate* is 387 # later than *<value>*. 388 # The operator name can only contain lowercase letters (a-z). 389 # The maximum length is 32 characters. 390 }, 391 }, 392 "displayOptions": { # The display options for a property. # Options that determine how the property is displayed in the Cloud Search 393 # results page if it is specified to be displayed in the object's 394 # display options 395 # . 396 "displayLabel": "A String", # The user friendly label for the property that will be used if the property 397 # is specified to be displayed in ObjectDisplayOptions. If given, the display 398 # label will be shown in front of the property values when the property is 399 # part of the object display options. For example, if the property value is 400 # '1', the value by itself may not be useful context for the user. If the 401 # display name given was 'priority', then the user will see 'priority : 1' in 402 # the search results which provides clear conext to search users. This is 403 # OPTIONAL; if not given, only the property values will be displayed. 404 # The maximum length is 32 characters. 405 }, 406 "booleanPropertyOptions": { # Options for boolean properties. 407 "operatorOptions": { # Used to provide a search operator for boolean properties. This is # If set, describes how the boolean should be used as a search operator. 408 # optional. Search operators let users restrict the query to specific fields 409 # relevant to the type of item being searched. 410 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 411 # boolean property. For example, if operatorName is *closed* and the 412 # property's name is *isClosed*, then queries like 413 # *closed:<value>* will show results only where the value of the 414 # property named *isClosed* matches *<value>*. By contrast, a 415 # search that uses the same *<value>* without an operator will return 416 # all items where *<value>* matches the value of any 417 # String properties or text within the content field for the item. 418 # The operator name can only contain lowercase letters (a-z). 419 # The maximum length is 32 characters. 420 }, 421 }, 422 "isFacetable": True or False, # Indicates that the property can be used for generating facets. Cannot be 423 # true for properties whose type is object. IsReturnable must be true to set 424 # this option. 425 # Only supported for Boolean, Enum, and Text properties. 426 "doublePropertyOptions": { # Options for double properties. 427 "operatorOptions": { # Used to provide a search operator for double properties. This is # If set, describes how the double should be used as a search operator. 428 # optional. Search operators let users restrict the query to specific fields 429 # relevant to the type of item being searched. 430 "operatorName": "A String", # Indicates the operator name required in the query in order to use the 431 # double property in sorting or as a facet. 432 # The operator name can only contain lowercase letters (a-z). 433 # The maximum length is 32 characters. 434 }, 435 }, 436 "isRepeatable": True or False, # Indicates that multiple values are allowed for the property. For example, a 437 # document only has one description but can have multiple comments. Cannot be 438 # true for properties whose type is a boolean. 439 # If set to false, properties that contain more than one value will cause the 440 # indexing request for that item to be rejected. 441 "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this 442 # property. Only supported for Text properties. IsReturnable must be true to 443 # set this option. In a given datasource maximum of 5 properties can be 444 # marked as is_wildcard_searchable. 445 # 446 # Note: This is an alpha feature and is enabled for whitelisted users only. 447 "integerPropertyOptions": { # Options for integer properties. 448 "orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if 449 # isRepeatable 450 # is false. 451 "minimumValue": "A String", # The minimum value of the property. The minimum and maximum values for the 452 # property are used to rank results according to the 453 # ordered ranking. 454 # Indexing requests with values less than the minimum are accepted and 455 # ranked with the same weight as items indexed with the minimum value. 456 "operatorOptions": { # Used to provide a search operator for integer properties. This is # If set, describes how the integer should be used as a search operator. 457 # optional. Search operators let users restrict the query to specific fields 458 # relevant to the type of item being searched. 459 "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 460 # integer property using the less-than operator. For example, if 461 # lessThanOperatorName is *prioritybelow* and the property's name is 462 # *priorityVal*, then queries like *prioritybelow:<value>* will 463 # show results only where the value of the property named *priorityVal* is 464 # less than *<value>*. 465 # The operator name can only contain lowercase letters (a-z). 466 # The maximum length is 32 characters. 467 "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 468 # integer property using the greater-than operator. For example, if 469 # greaterThanOperatorName is *priorityabove* and the property's name is 470 # *priorityVal*, then queries like *priorityabove:<value>* will 471 # show results only where the value of the property named *priorityVal* is 472 # greater than *<value>*. 473 # The operator name can only contain lowercase letters (a-z). 474 # The maximum length is 32 characters. 475 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 476 # integer property. For example, if operatorName is *priority* and the 477 # property's name is *priorityVal*, then queries like 478 # *priority:<value>* will show results only where the value of the 479 # property named *priorityVal* matches *<value>*. By contrast, a 480 # search that uses the same *<value>* without an operator will return 481 # all items where *<value>* matches the value of any String 482 # properties or text within the content field for the item. 483 # The operator name can only contain lowercase letters (a-z). 484 # The maximum length is 32 characters. 485 }, 486 "maximumValue": "A String", # The maximum value of the property. The minimum and maximum values for the 487 # property are used to rank results according to the 488 # ordered ranking. 489 # Indexing requests with values greater than the maximum are accepted and 490 # ranked with the same weight as items indexed with the maximum value. 491 }, 492 }, 493 ], 494 "name": "A String", # Name for the object, which then defines its type. Item indexing requests 495 # should set the 496 # objectType field 497 # equal to this value. For example, if *name* is *Document*, then indexing 498 # requests for items of type Document should set 499 # objectType equal to 500 # *Document*. Each object definition must be uniquely named within a schema. 501 # The name must start with a letter and can only contain letters (A-Z, a-z) 502 # or numbers (0-9). 503 # The maximum length is 256 characters. 504 "options": { # The options for an object. # The optional object-specific options. 505 "freshnessOptions": { # Indicates which freshness property to use when adjusting search ranking for # The freshness options for an object. 506 # an item. Fresher, more recent dates indicate higher quality. Use the 507 # freshness option property that best works with your data. For fileshare 508 # documents, last modified time is most relevant. For calendar event data, 509 # the time when the event occurs is a more relevant freshness indicator. In 510 # this way, calendar events that occur closer to the time of the search query 511 # are considered higher quality and ranked accordingly. 512 "freshnessDuration": "A String", # The duration after which an object should be considered 513 # stale. The default value is 180 days (in seconds). 514 "freshnessProperty": "A String", # This property indicates the freshness level of the object in the index. 515 # If set, this property must be a top-level property within the 516 # property definitions 517 # and it must be a 518 # timestamp type 519 # or 520 # date type. 521 # Otherwise, the Indexing API uses 522 # updateTime 523 # as the freshness indicator. 524 # The maximum length is 256 characters. 525 # 526 # When a property is used to calculate fresheness, the value defaults 527 # to 2 years from the current time. 528 }, 529 "displayOptions": { # The display options for an object. # Options that determine how the object is displayed in the Cloud Search 530 # results page. 531 "metalines": [ # Defines the properties that will be displayed in the metalines of the 532 # search results. The property values will be displayed in the order given 533 # here. If a property holds multiple values, all of the values will be 534 # diplayed before the next properties. For this reason, it is a good practice 535 # to specify singular properties before repeated properties in this list. All 536 # of the properties must set 537 # is_returnable 538 # to true. The maximum number of metalines is 3. 539 { # A metaline is a list of properties that are displayed along with the search 540 # result to provide context. 541 "properties": [ # The list of displayed properties for the metaline. The maxiumum number of 542 # properties is 5. 543 { # A reference to a top-level property within the object that should be 544 # displayed in search results. The values of the chosen properties will be 545 # displayed in the search results along with the 546 # dislpay label 547 # for that property if one is specified. If a display label is not specified, 548 # only the values will be shown. 549 "propertyName": "A String", # The name of the top-level property as defined in a property definition 550 # for the object. If the name is not a defined property in the schema, an 551 # error will be given when attempting to update the schema. 552 }, 553 ], 554 }, 555 ], 556 "objectDisplayLabel": "A String", # The user friendly label to display in the search result to inidicate the 557 # type of the item. This is OPTIONAL; if not given, an object label will not 558 # be displayed on the context line of the search results. The maximum length 559 # is 32 characters. 560 }, 561 }, 562 }, 563 ], 564 "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this 565 # schema. After modifying the schema, wait for operations to complete 566 # before indexing additional content. 567 "A String", 568 ], 569 }</pre> 570</div> 571 572<div class="method"> 573 <code class="details" id="updateSchema">updateSchema(name, body, x__xgafv=None)</code> 574 <pre>Updates the schema of a data source. 575 576Args: 577 name: string, Name of the data source to update Schema. Format: 578datasources/{source_id} (required) 579 body: object, The request body. (required) 580 The object takes the form of: 581 582{ 583 "validateOnly": True or False, # If true, the request will be validated without side effects. 584 "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options. 585 "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. 586 # Otherwise, ignore this field. 587 }, 588 "schema": { # The schema definition for a data source. # The new schema for the source. 589 "objectDefinitions": [ # The list of top-level objects for the data source. 590 # The maximum number of elements is 10. 591 { # The definition for an object within a data source. 592 "propertyDefinitions": [ # The property definitions for the object. 593 # The maximum number of elements is 1000. 594 { # The definition of a property within an object. 595 "htmlPropertyOptions": { # Options for html properties. 596 "retrievalImportance": { # Indicates the search quality importance of the tokens within the 597 # field when used for retrieval. Can only be set to DEFAULT or NONE. 598 "importance": "A String", # Indicates the ranking importance given to property when it is matched 599 # during retrieval. Once set, the token importance of a property cannot be 600 # changed. 601 }, 602 "operatorOptions": { # Used to provide a search operator for html properties. This is optional. # If set, describes how the property should be used as a search operator. 603 # Search operators let users restrict the query to specific fields relevant 604 # to the type of item being searched. 605 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 606 # html property. For example, if operatorName is *subject* and the 607 # property's name is *subjectLine*, then queries like 608 # *subject:<value>* will show results only where the value of the 609 # property named *subjectLine* matches *<value>*. By contrast, a 610 # search that uses the same *<value>* without an operator will return 611 # all items where *<value>* matches the value of any 612 # html properties or text within the content field for the item. 613 # The operator name can only contain lowercase letters (a-z). 614 # The maximum length is 32 characters. 615 }, 616 }, 617 "textPropertyOptions": { # Options for text properties. 618 "retrievalImportance": { # Indicates the search quality importance of the tokens within the 619 # field when used for retrieval. 620 "importance": "A String", # Indicates the ranking importance given to property when it is matched 621 # during retrieval. Once set, the token importance of a property cannot be 622 # changed. 623 }, 624 "operatorOptions": { # Used to provide a search operator for text properties. This is optional. # If set, describes how the property should be used as a search operator. 625 # Search operators let users restrict the query to specific fields relevant 626 # to the type of item being searched. 627 "exactMatchWithOperator": True or False, # If true, the text value will be tokenized as one atomic value in 628 # operator searches and facet matches. For example, if the operator name is 629 # "genre" and the value is "science-fiction" the query restrictions 630 # "genre:science" and "genre:fiction" will not match the item; 631 # "genre:science-fiction" will. Value matching is case-sensitive 632 # and does not remove special characters. 633 # If false, the text will be tokenized. For example, if the value is 634 # "science-fiction" the queries "genre:science" and "genre:fiction" will 635 # match the item. 636 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 637 # text property. For example, if operatorName is *subject* and the 638 # property's name is *subjectLine*, then queries like 639 # *subject:<value>* will show results only where the value of the 640 # property named *subjectLine* matches *<value>*. By contrast, a 641 # search that uses the same *<value>* without an operator will return 642 # all items where *<value>* matches the value of any 643 # text properties or text within the content field for the item. 644 # The operator name can only contain lowercase letters (a-z). 645 # The maximum length is 32 characters. 646 }, 647 }, 648 "name": "A String", # The name of the property. Item indexing requests sent to the Indexing API 649 # should set the property name 650 # equal to this value. For example, if name is *subject_line*, then indexing 651 # requests for document items with subject fields should set the 652 # name for that field equal to 653 # *subject_line*. Use the name as the identifier for the object property. 654 # Once registered as a property for an object, you cannot re-use this name 655 # for another property within that object. 656 # The name must start with a letter and can only contain letters (A-Z, a-z) 657 # or numbers (0-9). 658 # The maximum length is 256 characters. 659 "enumPropertyOptions": { # Options for enum properties, which allow you to define a restricted set of 660 # strings to match user queries, set rankings for those string values, and 661 # define an operator name to be paired with those strings so that users can 662 # narrow results to only items with a specific value. For example, for items in 663 # a request tracking system with priority information, you could define *p0* as 664 # an allowable enum value and tie this enum to the operator name *priority* so 665 # that search users could add *priority:p0* to their query to restrict the set 666 # of results to only those items indexed with the value *p0*. 667 "orderedRanking": "A String", # Used to specify the ordered ranking for the enumeration that determines how 668 # the integer values provided in the possible EnumValuePairs are used to rank 669 # results. If specified, integer values must be provided for all possible 670 # EnumValuePair values given for this property. Can only be used if 671 # isRepeatable 672 # is false. 673 "operatorOptions": { # Used to provide a search operator for enum properties. This is # If set, describes how the enum should be used as a search operator. 674 # optional. Search operators let users restrict the query to specific fields 675 # relevant to the type of item being searched. For example, if you provide no 676 # operator for a *priority* enum property with possible values *p0* and *p1*, 677 # a query that contains the term *p0* will return items that have *p0* as the 678 # value of the *priority* property, as well as any items that contain the 679 # string *p0* in other fields. If you provide an operator name for the enum, 680 # such as *priority*, then search users can use that operator to refine 681 # results to only items that have *p0* as this property's value, with the 682 # query *priority:p0*. 683 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 684 # enum property. For example, if operatorName is *priority* and the 685 # property's name is *priorityVal*, then queries like 686 # *priority:<value>* will show results only where the value of the 687 # property named *priorityVal* matches *<value>*. By contrast, a 688 # search that uses the same *<value>* without an operator will return 689 # all items where *<value>* matches the value of any String 690 # properties or text within the content field for the item. 691 # The operator name can only contain lowercase letters (a-z). 692 # The maximum length is 32 characters. 693 }, 694 "possibleValues": [ # The list of possible values for the enumeration property. All 695 # EnumValuePairs must provide a string value. If you specify an integer value 696 # for one EnumValuePair, then all possible EnumValuePairs must provide an 697 # integer value. Both the string value and integer value must be unique over 698 # all possible values. Once set, possible values cannot be removed or 699 # modified. If you supply an ordered ranking and think you might insert 700 # additional enum values in the future, leave gaps in the initial integer 701 # values to allow adding a value in between previously registered values. 702 # The maximum number of elements is 100. 703 { # The enumeration value pair defines two things: a required string value and 704 # an optional integer value. The string value defines the necessary query 705 # term required to retrieve that item, such as *p0* for a priority item. 706 # The integer value determines the ranking of that string value relative 707 # to other enumerated values for the same property. For example, you might 708 # associate *p0* with *0* and define another enum pair such as *p1* and *1*. 709 # You must use the integer value in combination with 710 # ordered 711 # ranking to 712 # set the ranking of a given value relative to other enumerated values for 713 # the same property name. Here, a ranking order of DESCENDING for *priority* 714 # properties results in a ranking boost for items indexed with a value of 715 # *p0* compared to items indexed with a value of *p1*. Without a specified 716 # ranking order, the integer value has no effect on item ranking. 717 "stringValue": "A String", # The string value of the EnumValuePair. 718 # The maximum length is 32 characters. 719 "integerValue": 42, # The integer value of the EnumValuePair which must be non-negative. 720 # Optional. 721 }, 722 ], 723 }, 724 "isReturnable": True or False, # Indicates that the property identifies data that should be returned in 725 # search results via the Query API. If set to *true*, indicates that Query 726 # API users can use matching property fields in results. However, storing 727 # fields requires more space allocation and uses more bandwidth for search 728 # queries, which impacts performance over large datasets. Set to *true* here 729 # only if the field is needed for search results. Cannot be true for 730 # properties whose type is an object. 731 "isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for 732 # properties that are repeatable. Cannot be true for properties whose type 733 # is object or user identifier. IsReturnable must be true to set this option. 734 # Only supported for Boolean, Date, Double, Integer, and Timestamp 735 # properties. 736 "objectPropertyOptions": { # Options for object properties. 737 "subobjectProperties": [ # The properties of the sub-object. These properties represent a nested 738 # object. For example, if this property represents a postal address, the 739 # subobjectProperties might be named *street*, *city*, and *state*. 740 # The maximum number of elements is 1000. 741 # Object with schema name: PropertyDefinition 742 ], 743 }, 744 "timestampPropertyOptions": { # Options for timestamp properties. 745 "operatorOptions": { # Used to provide a search operator for timestamp properties. This is # If set, describes how the timestamp should be used as a search operator. 746 # optional. Search operators let users restrict the query to specific fields 747 # relevant to the type of item being searched. 748 "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 749 # timestamp property using the less-than operator. For example, if 750 # lessThanOperatorName is *closedbefore* and the property's name is 751 # *closeDate*, then queries like *closedbefore:<value>* will 752 # show results only where the value of the property named *closeDate* is 753 # earlier than *<value>*. 754 # The operator name can only contain lowercase letters (a-z). 755 # The maximum length is 32 characters. 756 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 757 # timestamp property. For example, if operatorName is *closedon* and the 758 # property's name is *closeDate*, then queries like 759 # *closedon:<value>* will show results only where the value of the 760 # property named *closeDate* matches *<value>*. By contrast, a 761 # search that uses the same *<value>* without an operator will return 762 # all items where *<value>* matches the value of any String 763 # properties or text within the content field for the item. The operator 764 # name can only contain lowercase letters (a-z). The maximum length is 32 765 # characters. 766 "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 767 # timestamp property using the greater-than operator. For example, if 768 # greaterThanOperatorName is *closedafter* and the property's name is 769 # *closeDate*, then queries like *closedafter:<value>* will 770 # show results only where the value of the property named *closeDate* is 771 # later than *<value>*. 772 # The operator name can only contain lowercase letters (a-z). 773 # The maximum length is 32 characters. 774 }, 775 }, 776 "datePropertyOptions": { # Options for date properties. 777 "operatorOptions": { # Optional. Provides a search operator for date properties. # If set, describes how the date should be used as a search operator. 778 # Search operators let users restrict the query to specific fields relevant 779 # to the type of item being searched. 780 "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 781 # date property using the less-than operator. For example, if 782 # lessThanOperatorName is *closedbefore* and the property's name is 783 # *closeDate*, then queries like *closedbefore:<value>* will 784 # show results only where the value of the property named *closeDate* is 785 # earlier than *<value>*. 786 # The operator name can only contain lowercase letters (a-z). 787 # The maximum length is 32 characters. 788 "operatorName": "A String", # Indicates the actual string required in the query in order to isolate the 789 # date property. For example, suppose an issue tracking schema object 790 # has a property named *closeDate* that specifies an operator with an 791 # operatorName of *closedon*. For searches on that data, queries like 792 # *closedon:<value>* will show results only where the value of the 793 # *closeDate* property matches *<value>*. By contrast, a 794 # search that uses the same *<value>* without an operator will return 795 # all items where *<value>* matches the value of any String 796 # properties or text within the content field for the indexed datasource. 797 # The operator name can only contain lowercase letters (a-z). 798 # The maximum length is 32 characters. 799 "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 800 # date property using the greater-than operator. For example, if 801 # greaterThanOperatorName is *closedafter* and the property's name is 802 # *closeDate*, then queries like *closedafter:<value>* will 803 # show results only where the value of the property named *closeDate* is 804 # later than *<value>*. 805 # The operator name can only contain lowercase letters (a-z). 806 # The maximum length is 32 characters. 807 }, 808 }, 809 "displayOptions": { # The display options for a property. # Options that determine how the property is displayed in the Cloud Search 810 # results page if it is specified to be displayed in the object's 811 # display options 812 # . 813 "displayLabel": "A String", # The user friendly label for the property that will be used if the property 814 # is specified to be displayed in ObjectDisplayOptions. If given, the display 815 # label will be shown in front of the property values when the property is 816 # part of the object display options. For example, if the property value is 817 # '1', the value by itself may not be useful context for the user. If the 818 # display name given was 'priority', then the user will see 'priority : 1' in 819 # the search results which provides clear conext to search users. This is 820 # OPTIONAL; if not given, only the property values will be displayed. 821 # The maximum length is 32 characters. 822 }, 823 "booleanPropertyOptions": { # Options for boolean properties. 824 "operatorOptions": { # Used to provide a search operator for boolean properties. This is # If set, describes how the boolean should be used as a search operator. 825 # optional. Search operators let users restrict the query to specific fields 826 # relevant to the type of item being searched. 827 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 828 # boolean property. For example, if operatorName is *closed* and the 829 # property's name is *isClosed*, then queries like 830 # *closed:<value>* will show results only where the value of the 831 # property named *isClosed* matches *<value>*. By contrast, a 832 # search that uses the same *<value>* without an operator will return 833 # all items where *<value>* matches the value of any 834 # String properties or text within the content field for the item. 835 # The operator name can only contain lowercase letters (a-z). 836 # The maximum length is 32 characters. 837 }, 838 }, 839 "isFacetable": True or False, # Indicates that the property can be used for generating facets. Cannot be 840 # true for properties whose type is object. IsReturnable must be true to set 841 # this option. 842 # Only supported for Boolean, Enum, and Text properties. 843 "doublePropertyOptions": { # Options for double properties. 844 "operatorOptions": { # Used to provide a search operator for double properties. This is # If set, describes how the double should be used as a search operator. 845 # optional. Search operators let users restrict the query to specific fields 846 # relevant to the type of item being searched. 847 "operatorName": "A String", # Indicates the operator name required in the query in order to use the 848 # double property in sorting or as a facet. 849 # The operator name can only contain lowercase letters (a-z). 850 # The maximum length is 32 characters. 851 }, 852 }, 853 "isRepeatable": True or False, # Indicates that multiple values are allowed for the property. For example, a 854 # document only has one description but can have multiple comments. Cannot be 855 # true for properties whose type is a boolean. 856 # If set to false, properties that contain more than one value will cause the 857 # indexing request for that item to be rejected. 858 "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this 859 # property. Only supported for Text properties. IsReturnable must be true to 860 # set this option. In a given datasource maximum of 5 properties can be 861 # marked as is_wildcard_searchable. 862 # 863 # Note: This is an alpha feature and is enabled for whitelisted users only. 864 "integerPropertyOptions": { # Options for integer properties. 865 "orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if 866 # isRepeatable 867 # is false. 868 "minimumValue": "A String", # The minimum value of the property. The minimum and maximum values for the 869 # property are used to rank results according to the 870 # ordered ranking. 871 # Indexing requests with values less than the minimum are accepted and 872 # ranked with the same weight as items indexed with the minimum value. 873 "operatorOptions": { # Used to provide a search operator for integer properties. This is # If set, describes how the integer should be used as a search operator. 874 # optional. Search operators let users restrict the query to specific fields 875 # relevant to the type of item being searched. 876 "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 877 # integer property using the less-than operator. For example, if 878 # lessThanOperatorName is *prioritybelow* and the property's name is 879 # *priorityVal*, then queries like *prioritybelow:<value>* will 880 # show results only where the value of the property named *priorityVal* is 881 # less than *<value>*. 882 # The operator name can only contain lowercase letters (a-z). 883 # The maximum length is 32 characters. 884 "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the 885 # integer property using the greater-than operator. For example, if 886 # greaterThanOperatorName is *priorityabove* and the property's name is 887 # *priorityVal*, then queries like *priorityabove:<value>* will 888 # show results only where the value of the property named *priorityVal* is 889 # greater than *<value>*. 890 # The operator name can only contain lowercase letters (a-z). 891 # The maximum length is 32 characters. 892 "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the 893 # integer property. For example, if operatorName is *priority* and the 894 # property's name is *priorityVal*, then queries like 895 # *priority:<value>* will show results only where the value of the 896 # property named *priorityVal* matches *<value>*. By contrast, a 897 # search that uses the same *<value>* without an operator will return 898 # all items where *<value>* matches the value of any String 899 # properties or text within the content field for the item. 900 # The operator name can only contain lowercase letters (a-z). 901 # The maximum length is 32 characters. 902 }, 903 "maximumValue": "A String", # The maximum value of the property. The minimum and maximum values for the 904 # property are used to rank results according to the 905 # ordered ranking. 906 # Indexing requests with values greater than the maximum are accepted and 907 # ranked with the same weight as items indexed with the maximum value. 908 }, 909 }, 910 ], 911 "name": "A String", # Name for the object, which then defines its type. Item indexing requests 912 # should set the 913 # objectType field 914 # equal to this value. For example, if *name* is *Document*, then indexing 915 # requests for items of type Document should set 916 # objectType equal to 917 # *Document*. Each object definition must be uniquely named within a schema. 918 # The name must start with a letter and can only contain letters (A-Z, a-z) 919 # or numbers (0-9). 920 # The maximum length is 256 characters. 921 "options": { # The options for an object. # The optional object-specific options. 922 "freshnessOptions": { # Indicates which freshness property to use when adjusting search ranking for # The freshness options for an object. 923 # an item. Fresher, more recent dates indicate higher quality. Use the 924 # freshness option property that best works with your data. For fileshare 925 # documents, last modified time is most relevant. For calendar event data, 926 # the time when the event occurs is a more relevant freshness indicator. In 927 # this way, calendar events that occur closer to the time of the search query 928 # are considered higher quality and ranked accordingly. 929 "freshnessDuration": "A String", # The duration after which an object should be considered 930 # stale. The default value is 180 days (in seconds). 931 "freshnessProperty": "A String", # This property indicates the freshness level of the object in the index. 932 # If set, this property must be a top-level property within the 933 # property definitions 934 # and it must be a 935 # timestamp type 936 # or 937 # date type. 938 # Otherwise, the Indexing API uses 939 # updateTime 940 # as the freshness indicator. 941 # The maximum length is 256 characters. 942 # 943 # When a property is used to calculate fresheness, the value defaults 944 # to 2 years from the current time. 945 }, 946 "displayOptions": { # The display options for an object. # Options that determine how the object is displayed in the Cloud Search 947 # results page. 948 "metalines": [ # Defines the properties that will be displayed in the metalines of the 949 # search results. The property values will be displayed in the order given 950 # here. If a property holds multiple values, all of the values will be 951 # diplayed before the next properties. For this reason, it is a good practice 952 # to specify singular properties before repeated properties in this list. All 953 # of the properties must set 954 # is_returnable 955 # to true. The maximum number of metalines is 3. 956 { # A metaline is a list of properties that are displayed along with the search 957 # result to provide context. 958 "properties": [ # The list of displayed properties for the metaline. The maxiumum number of 959 # properties is 5. 960 { # A reference to a top-level property within the object that should be 961 # displayed in search results. The values of the chosen properties will be 962 # displayed in the search results along with the 963 # dislpay label 964 # for that property if one is specified. If a display label is not specified, 965 # only the values will be shown. 966 "propertyName": "A String", # The name of the top-level property as defined in a property definition 967 # for the object. If the name is not a defined property in the schema, an 968 # error will be given when attempting to update the schema. 969 }, 970 ], 971 }, 972 ], 973 "objectDisplayLabel": "A String", # The user friendly label to display in the search result to inidicate the 974 # type of the item. This is OPTIONAL; if not given, an object label will not 975 # be displayed on the context line of the search results. The maximum length 976 # is 32 characters. 977 }, 978 }, 979 }, 980 ], 981 "operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this 982 # schema. After modifying the schema, wait for operations to complete 983 # before indexing additional content. 984 "A String", 985 ], 986 }, 987 } 988 989 x__xgafv: string, V1 error format. 990 Allowed values 991 1 - v1 error format 992 2 - v2 error format 993 994Returns: 995 An object of the form: 996 997 { # This resource represents a long-running operation that is the result of a 998 # network API call. 999 "metadata": { # Service-specific metadata associated with the operation. It typically 1000 # contains progress information and common metadata such as create time. 1001 # Some services might not provide such metadata. Any method that returns a 1002 # long-running operation should document the metadata type, if any. 1003 "a_key": "", # Properties of the object. Contains field @type with type URL. 1004 }, 1005 "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. 1006 # different programming environments, including REST APIs and RPC APIs. It is 1007 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 1008 # three pieces of data: error code, error message, and error details. 1009 # 1010 # You can find out more about this error model and how to work with it in the 1011 # [API Design Guide](https://cloud.google.com/apis/design/errors). 1012 "message": "A String", # A developer-facing error message, which should be in English. Any 1013 # user-facing error message should be localized and sent in the 1014 # google.rpc.Status.details field, or localized by the client. 1015 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1016 "details": [ # A list of messages that carry the error details. There is a common set of 1017 # message types for APIs to use. 1018 { 1019 "a_key": "", # Properties of the object. Contains field @type with type URL. 1020 }, 1021 ], 1022 }, 1023 "done": True or False, # If the value is `false`, it means the operation is still in progress. 1024 # If `true`, the operation is completed, and either `error` or `response` is 1025 # available. 1026 "response": { # The normal response of the operation in case of success. If the original 1027 # method returns no data on success, such as `Delete`, the response is 1028 # `google.protobuf.Empty`. If the original method is standard 1029 # `Get`/`Create`/`Update`, the response should be the resource. For other 1030 # methods, the response should have the type `XxxResponse`, where `Xxx` 1031 # is the original method name. For example, if the original method name 1032 # is `TakeSnapshot()`, the inferred response type is 1033 # `TakeSnapshotResponse`. 1034 "a_key": "", # Properties of the object. Contains field @type with type URL. 1035 }, 1036 "name": "A String", # The server-assigned name, which is only unique within the same service that 1037 # originally returns it. If you use the default HTTP mapping, the 1038 # `name` should be a resource name ending with `operations/{unique_id}`. 1039 }</pre> 1040</div> 1041 1042</body></html>