docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.html b/docs/dyn/cloudsearch_v1.indexing.datasources.html
index ddd90f9..80916be 100644
--- a/docs/dyn/cloudsearch_v1.indexing.datasources.html
+++ b/docs/dyn/cloudsearch_v1.indexing.datasources.html
@@ -110,9 +110,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -150,6 +147,9 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
}</pre>
</div>
@@ -181,206 +181,67 @@
"objectDefinitions": [ # The list of top-level objects for the data source.
# The maximum number of elements is 10.
{ # The definition for an object within a data source.
+ "options": { # The options for an object. # The optional object-specific options.
+ "displayOptions": { # The display options for an object. # Options that determine how the object is displayed in the Cloud Search
+ # results page.
+ "objectDisplayLabel": "A String", # The user friendly label to display in the search result to indicate the
+ # type of the item. This is OPTIONAL; if not provided, an object label isn't
+ # displayed on the context line of the search results. The maximum length
+ # is 64 characters.
+ "metalines": [ # Defines the properties that are displayed in the metalines of the
+ # search results. The property values are displayed in the order given
+ # here. If a property holds multiple values, all of the values are
+ # displayed before the next properties. For this reason, it is a good
+ # practice to specify singular properties before repeated properties in this
+ # list. All of the properties must set
+ # is_returnable
+ # to true. The maximum number of metalines is 3.
+ { # A metaline is a list of properties that are displayed along with the search
+ # result to provide context.
+ "properties": [ # The list of displayed properties for the metaline. The maximum number of
+ # properties is 5.
+ { # A reference to a top-level property within the object that should be
+ # displayed in search results. The values of the chosen properties is
+ # displayed in the search results along with the
+ # display label
+ # for that property if one is specified. If a display label is not specified,
+ # only the values is shown.
+ "propertyName": "A String", # The name of the top-level property as defined in a property definition
+ # for the object. If the name is not a defined property in the schema, an
+ # error is given when attempting to update the schema.
+ },
+ ],
+ },
+ ],
+ },
+ "freshnessOptions": { # Indicates which freshness property to use when adjusting search ranking for # The freshness options for an object.
+ # an item. Fresher, more recent dates indicate higher quality. Use the
+ # freshness option property that best works with your data. For fileshare
+ # documents, last modified time is most relevant. For calendar event data,
+ # the time when the event occurs is a more relevant freshness indicator. In
+ # this way, calendar events that occur closer to the time of the search query
+ # are considered higher quality and ranked accordingly.
+ "freshnessDuration": "A String", # The duration after which an object should be considered
+ # stale. The default value is 180 days (in seconds).
+ "freshnessProperty": "A String", # This property indicates the freshness level of the object in the index.
+ # If set, this property must be a top-level property within the
+ # property definitions
+ # and it must be a
+ # timestamp type
+ # or
+ # date type.
+ # Otherwise, the Indexing API uses
+ # updateTime
+ # as the freshness indicator.
+ # The maximum length is 256 characters.
+ #
+ # When a property is used to calculate freshness, the value defaults
+ # to 2 years from the current time.
+ },
+ },
"propertyDefinitions": [ # The property definitions for the object.
# The maximum number of elements is 1000.
{ # The definition of a property within an object.
- "enumPropertyOptions": { # Options for enum properties, which allow you to define a restricted set of
- # strings to match user queries, set rankings for those string values, and
- # define an operator name to be paired with those strings so that users can
- # narrow results to only items with a specific value. For example, for items in
- # a request tracking system with priority information, you could define *p0* as
- # an allowable enum value and tie this enum to the operator name *priority* so
- # that search users could add *priority:p0* to their query to restrict the set
- # of results to only those items indexed with the value *p0*.
- "orderedRanking": "A String", # Used to specify the ordered ranking for the enumeration that determines how
- # the integer values provided in the possible EnumValuePairs are used to rank
- # results. If specified, integer values must be provided for all possible
- # EnumValuePair values given for this property. Can only be used if
- # isRepeatable
- # is false.
- "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.
- # optional. Search operators let users restrict the query to specific fields
- # relevant to the type of item being searched. For example, if you provide no
- # operator for a *priority* enum property with possible values *p0* and *p1*,
- # a query that contains the term *p0* returns items that have *p0* as the
- # value of the *priority* property, as well as any items that contain the
- # string *p0* in other fields. If you provide an operator name for the enum,
- # such as *priority*, then search users can use that operator to refine
- # results to only items that have *p0* as this property's value, with the
- # query *priority:p0*.
- "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # enum property. For example, if operatorName is *priority* and the
- # property's name is *priorityVal*, then queries like
- # *priority:&lt;value&gt;* show results only where the value of the
- # property named *priorityVal* matches *&lt;value&gt;*. By contrast, a
- # search that uses the same *&lt;value&gt;* without an operator returns
- # all items where *&lt;value&gt;* matches the value of any String
- # properties or text within the content field for the item.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- "possibleValues": [ # The list of possible values for the enumeration property. All
- # EnumValuePairs must provide a string value. If you specify an integer value
- # for one EnumValuePair, then all possible EnumValuePairs must provide an
- # integer value. Both the string value and integer value must be unique over
- # all possible values. Once set, possible values cannot be removed or
- # modified. If you supply an ordered ranking and think you might insert
- # additional enum values in the future, leave gaps in the initial integer
- # values to allow adding a value in between previously registered values.
- # The maximum number of elements is 100.
- { # The enumeration value pair defines two things: a required string value and
- # an optional integer value. The string value defines the necessary query
- # term required to retrieve that item, such as *p0* for a priority item.
- # The integer value determines the ranking of that string value relative
- # to other enumerated values for the same property. For example, you might
- # associate *p0* with *0* and define another enum pair such as *p1* and *1*.
- # You must use the integer value in combination with
- # ordered
- # ranking to
- # set the ranking of a given value relative to other enumerated values for
- # the same property name. Here, a ranking order of DESCENDING for *priority*
- # properties results in a ranking boost for items indexed with a value of
- # *p0* compared to items indexed with a value of *p1*. Without a specified
- # ranking order, the integer value has no effect on item ranking.
- "integerValue": 42, # The integer value of the EnumValuePair which must be non-negative.
- # Optional.
- "stringValue": "A String", # The string value of the EnumValuePair.
- # The maximum length is 32 characters.
- },
- ],
- },
- "displayOptions": { # The display options for a property. # Options that determine how the property is displayed in the Cloud Search
- # results page if it is specified to be displayed in the object's
- # display options
- # .
- "displayLabel": "A String", # The user friendly label for the property that is used if the property
- # is specified to be displayed in ObjectDisplayOptions. If provided, the
- # display label is shown in front of the property values when the property is
- # part of the object display options. For example, if the property value is
- # '1', the value by itself may not be useful context for the user. If the
- # display name given was 'priority', then the user sees 'priority : 1' in
- # the search results which provides clear context to search users. This is
- # OPTIONAL; if not given, only the property values are displayed.
- # The maximum length is 64 characters.
- },
- "datePropertyOptions": { # Options for date properties.
- "operatorOptions": { # Optional. Provides a search operator for date properties. # If set, describes how the date should be used as a search operator.
- # Search operators let users restrict the query to specific fields relevant
- # to the type of item being searched.
- "operatorName": "A String", # Indicates the actual string required in the query in order to isolate the
- # date property. For example, suppose an issue tracking schema object
- # has a property named *closeDate* that specifies an operator with an
- # operatorName of *closedon*. For searches on that data, queries like
- # *closedon:&lt;value&gt;* show results only where the value of the
- # *closeDate* property matches *&lt;value&gt;*. By contrast, a
- # search that uses the same *&lt;value&gt;* without an operator returns
- # all items where *&lt;value&gt;* matches the value of any String
- # properties or text within the content field for the indexed datasource.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # date property using the greater-than operator. For example, if
- # greaterThanOperatorName is *closedafter* and the property's name is
- # *closeDate*, then queries like *closedafter:&lt;value&gt;*
- # show results only where the value of the property named *closeDate* is
- # later than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # date property using the less-than operator. For example, if
- # lessThanOperatorName is *closedbefore* and the property's name is
- # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
- # show results only where the value of the property named *closeDate* is
- # earlier than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- },
- "isFacetable": True or False, # Indicates that the property can be used for generating facets. Cannot be
- # true for properties whose type is object. IsReturnable must be true to set
- # this option.
- # Only supported for Boolean, Enum, and Text properties.
- "isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for
- # properties that are repeatable. Cannot be true for properties whose type
- # is object or user identifier. IsReturnable must be true to set this option.
- # Only supported for Boolean, Date, Double, Integer, and Timestamp
- # properties.
- "isReturnable": True or False, # Indicates that the property identifies data that should be returned in
- # search results via the Query API. If set to *true*, indicates that Query
- # API users can use matching property fields in results. However, storing
- # fields requires more space allocation and uses more bandwidth for search
- # queries, which impacts performance over large datasets. Set to *true* here
- # only if the field is needed for search results. Cannot be true for
- # properties whose type is an object.
- "name": "A String", # The name of the property. Item indexing requests sent to the Indexing API
- # should set the property name
- # equal to this value. For example, if name is *subject_line*, then indexing
- # requests for document items with subject fields should set the
- # name for that field equal to
- # *subject_line*. Use the name as the identifier for the object property.
- # Once registered as a property for an object, you cannot re-use this name
- # for another property within that object.
- # The name must start with a letter and can only contain letters (A-Z, a-z)
- # or numbers (0-9).
- # The maximum length is 256 characters.
- "booleanPropertyOptions": { # Options for boolean properties.
- "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.
- # optional. Search operators let users restrict the query to specific fields
- # relevant to the type of item being searched.
- "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # boolean property. For example, if operatorName is *closed* and the
- # property's name is *isClosed*, then queries like
- # *closed:&lt;value&gt;* show results only where the value of the
- # property named *isClosed* matches *&lt;value&gt;*. By contrast, a
- # search that uses the same *&lt;value&gt;* without an operator returns
- # all items where *&lt;value&gt;* matches the value of any
- # String properties or text within the content field for the item.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- },
- "timestampPropertyOptions": { # Options for timestamp properties.
- "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.
- # optional. Search operators let users restrict the query to specific fields
- # relevant to the type of item being searched.
- "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # timestamp property. For example, if operatorName is *closedon* and the
- # property's name is *closeDate*, then queries like
- # *closedon:&lt;value&gt;* show results only where the value of the
- # property named *closeDate* matches *&lt;value&gt;*. By contrast, a
- # search that uses the same *&lt;value&gt;* without an operator returns
- # all items where *&lt;value&gt;* matches the value of any String
- # properties or text within the content field for the item. The operator
- # name can only contain lowercase letters (a-z). The maximum length is 32
- # characters.
- "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # timestamp property using the greater-than operator. For example, if
- # greaterThanOperatorName is *closedafter* and the property's name is
- # *closeDate*, then queries like *closedafter:&lt;value&gt;*
- # show results only where the value of the property named *closeDate* is
- # later than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # timestamp property using the less-than operator. For example, if
- # lessThanOperatorName is *closedbefore* and the property's name is
- # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
- # show results only where the value of the property named *closeDate* is
- # earlier than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- },
- "doublePropertyOptions": { # Options for double properties.
- "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.
- # optional. Search operators let users restrict the query to specific fields
- # relevant to the type of item being searched.
- "operatorName": "A String", # Indicates the operator name required in the query in order to use the
- # double property in sorting or as a facet.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- },
"textPropertyOptions": { # Options for text properties.
"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.
# Search operators let users restrict the query to specific fields relevant
@@ -453,17 +314,17 @@
},
},
"integerPropertyOptions": { # Options for integer properties.
- "orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if
- # isRepeatable
- # is false.
- "maximumValue": "A String", # The maximum value of the property. The minimum and maximum values for the
- # property are used to rank results according to the
- # ordered ranking.
- # Indexing requests with values greater than the maximum are accepted and
- # ranked with the same weight as items indexed with the maximum value.
"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.
# optional. Search operators let users restrict the query to specific fields
# relevant to the type of item being searched.
+ "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # integer property using the less-than operator. For example, if
+ # lessThanOperatorName is *prioritybelow* and the property's name is
+ # *priorityVal*, then queries like *prioritybelow:&lt;value&gt;*
+ # show results only where the value of the property named *priorityVal* is
+ # less than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
# integer property. For example, if operatorName is *priority* and the
# property's name is *priorityVal*, then queries like
@@ -482,20 +343,217 @@
# greater than *&lt;value&gt;*.
# The operator name can only contain lowercase letters (a-z).
# The maximum length is 32 characters.
- "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # integer property using the less-than operator. For example, if
- # lessThanOperatorName is *prioritybelow* and the property's name is
- # *priorityVal*, then queries like *prioritybelow:&lt;value&gt;*
- # show results only where the value of the property named *priorityVal* is
- # less than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
},
"minimumValue": "A String", # The minimum value of the property. The minimum and maximum values for the
# property are used to rank results according to the
# ordered ranking.
# Indexing requests with values less than the minimum are accepted and
# ranked with the same weight as items indexed with the minimum value.
+ "orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if
+ # isRepeatable
+ # is false.
+ "maximumValue": "A String", # The maximum value of the property. The minimum and maximum values for the
+ # property are used to rank results according to the
+ # ordered ranking.
+ # Indexing requests with values greater than the maximum are accepted and
+ # ranked with the same weight as items indexed with the maximum value.
+ },
+ "enumPropertyOptions": { # Options for enum properties, which allow you to define a restricted set of
+ # strings to match user queries, set rankings for those string values, and
+ # define an operator name to be paired with those strings so that users can
+ # narrow results to only items with a specific value. For example, for items in
+ # a request tracking system with priority information, you could define *p0* as
+ # an allowable enum value and tie this enum to the operator name *priority* so
+ # that search users could add *priority:p0* to their query to restrict the set
+ # of results to only those items indexed with the value *p0*.
+ "possibleValues": [ # The list of possible values for the enumeration property. All
+ # EnumValuePairs must provide a string value. If you specify an integer value
+ # for one EnumValuePair, then all possible EnumValuePairs must provide an
+ # integer value. Both the string value and integer value must be unique over
+ # all possible values. Once set, possible values cannot be removed or
+ # modified. If you supply an ordered ranking and think you might insert
+ # additional enum values in the future, leave gaps in the initial integer
+ # values to allow adding a value in between previously registered values.
+ # The maximum number of elements is 100.
+ { # The enumeration value pair defines two things: a required string value and
+ # an optional integer value. The string value defines the necessary query
+ # term required to retrieve that item, such as *p0* for a priority item.
+ # The integer value determines the ranking of that string value relative
+ # to other enumerated values for the same property. For example, you might
+ # associate *p0* with *0* and define another enum pair such as *p1* and *1*.
+ # You must use the integer value in combination with
+ # ordered
+ # ranking to
+ # set the ranking of a given value relative to other enumerated values for
+ # the same property name. Here, a ranking order of DESCENDING for *priority*
+ # properties results in a ranking boost for items indexed with a value of
+ # *p0* compared to items indexed with a value of *p1*. Without a specified
+ # ranking order, the integer value has no effect on item ranking.
+ "integerValue": 42, # The integer value of the EnumValuePair which must be non-negative.
+ # Optional.
+ "stringValue": "A String", # The string value of the EnumValuePair.
+ # The maximum length is 32 characters.
+ },
+ ],
+ "orderedRanking": "A String", # Used to specify the ordered ranking for the enumeration that determines how
+ # the integer values provided in the possible EnumValuePairs are used to rank
+ # results. If specified, integer values must be provided for all possible
+ # EnumValuePair values given for this property. Can only be used if
+ # isRepeatable
+ # is false.
+ "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.
+ # optional. Search operators let users restrict the query to specific fields
+ # relevant to the type of item being searched. For example, if you provide no
+ # operator for a *priority* enum property with possible values *p0* and *p1*,
+ # a query that contains the term *p0* returns items that have *p0* as the
+ # value of the *priority* property, as well as any items that contain the
+ # string *p0* in other fields. If you provide an operator name for the enum,
+ # such as *priority*, then search users can use that operator to refine
+ # results to only items that have *p0* as this property's value, with the
+ # query *priority:p0*.
+ "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # enum property. For example, if operatorName is *priority* and the
+ # property's name is *priorityVal*, then queries like
+ # *priority:&lt;value&gt;* show results only where the value of the
+ # property named *priorityVal* matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator returns
+ # all items where *&lt;value&gt;* matches the value of any String
+ # properties or text within the content field for the item.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
+ },
+ "displayOptions": { # The display options for a property. # Options that determine how the property is displayed in the Cloud Search
+ # results page if it is specified to be displayed in the object's
+ # display options
+ # .
+ "displayLabel": "A String", # The user friendly label for the property that is used if the property
+ # is specified to be displayed in ObjectDisplayOptions. If provided, the
+ # display label is shown in front of the property values when the property is
+ # part of the object display options. For example, if the property value is
+ # '1', the value by itself may not be useful context for the user. If the
+ # display name given was 'priority', then the user sees 'priority : 1' in
+ # the search results which provides clear context to search users. This is
+ # OPTIONAL; if not given, only the property values are displayed.
+ # The maximum length is 64 characters.
+ },
+ "datePropertyOptions": { # Options for date properties.
+ "operatorOptions": { # Optional. Provides a search operator for date properties. # If set, describes how the date should be used as a search operator.
+ # Search operators let users restrict the query to specific fields relevant
+ # to the type of item being searched.
+ "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # date property using the greater-than operator. For example, if
+ # greaterThanOperatorName is *closedafter* and the property's name is
+ # *closeDate*, then queries like *closedafter:&lt;value&gt;*
+ # show results only where the value of the property named *closeDate* is
+ # later than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # date property using the less-than operator. For example, if
+ # lessThanOperatorName is *closedbefore* and the property's name is
+ # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
+ # show results only where the value of the property named *closeDate* is
+ # earlier than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ "operatorName": "A String", # Indicates the actual string required in the query in order to isolate the
+ # date property. For example, suppose an issue tracking schema object
+ # has a property named *closeDate* that specifies an operator with an
+ # operatorName of *closedon*. For searches on that data, queries like
+ # *closedon:&lt;value&gt;* show results only where the value of the
+ # *closeDate* property matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator returns
+ # all items where *&lt;value&gt;* matches the value of any String
+ # properties or text within the content field for the indexed datasource.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
+ },
+ "isFacetable": True or False, # Indicates that the property can be used for generating facets. Cannot be
+ # true for properties whose type is object. IsReturnable must be true to set
+ # this option.
+ # Only supported for Boolean, Enum, and Text properties.
+ "isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for
+ # properties that are repeatable. Cannot be true for properties whose type
+ # is object or user identifier. IsReturnable must be true to set this option.
+ # Only supported for Boolean, Date, Double, Integer, and Timestamp
+ # properties.
+ "isReturnable": True or False, # Indicates that the property identifies data that should be returned in
+ # search results via the Query API. If set to *true*, indicates that Query
+ # API users can use matching property fields in results. However, storing
+ # fields requires more space allocation and uses more bandwidth for search
+ # queries, which impacts performance over large datasets. Set to *true* here
+ # only if the field is needed for search results. Cannot be true for
+ # properties whose type is an object.
+ "name": "A String", # The name of the property. Item indexing requests sent to the Indexing API
+ # should set the property name
+ # equal to this value. For example, if name is *subject_line*, then indexing
+ # requests for document items with subject fields should set the
+ # name for that field equal to
+ # *subject_line*. Use the name as the identifier for the object property.
+ # Once registered as a property for an object, you cannot re-use this name
+ # for another property within that object.
+ # The name must start with a letter and can only contain letters (A-Z, a-z)
+ # or numbers (0-9).
+ # The maximum length is 256 characters.
+ "booleanPropertyOptions": { # Options for boolean properties.
+ "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.
+ # optional. Search operators let users restrict the query to specific fields
+ # relevant to the type of item being searched.
+ "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # boolean property. For example, if operatorName is *closed* and the
+ # property's name is *isClosed*, then queries like
+ # *closed:&lt;value&gt;* show results only where the value of the
+ # property named *isClosed* matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator returns
+ # all items where *&lt;value&gt;* matches the value of any
+ # String properties or text within the content field for the item.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
+ },
+ "timestampPropertyOptions": { # Options for timestamp properties.
+ "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.
+ # optional. Search operators let users restrict the query to specific fields
+ # relevant to the type of item being searched.
+ "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # timestamp property using the less-than operator. For example, if
+ # lessThanOperatorName is *closedbefore* and the property's name is
+ # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
+ # show results only where the value of the property named *closeDate* is
+ # earlier than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # timestamp property. For example, if operatorName is *closedon* and the
+ # property's name is *closeDate*, then queries like
+ # *closedon:&lt;value&gt;* show results only where the value of the
+ # property named *closeDate* matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator returns
+ # all items where *&lt;value&gt;* matches the value of any String
+ # properties or text within the content field for the item. The operator
+ # name can only contain lowercase letters (a-z). The maximum length is 32
+ # characters.
+ "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # timestamp property using the greater-than operator. For example, if
+ # greaterThanOperatorName is *closedafter* and the property's name is
+ # *closeDate*, then queries like *closedafter:&lt;value&gt;*
+ # show results only where the value of the property named *closeDate* is
+ # later than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
+ },
+ "doublePropertyOptions": { # Options for double properties.
+ "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.
+ # optional. Search operators let users restrict the query to specific fields
+ # relevant to the type of item being searched.
+ "operatorName": "A String", # Indicates the operator name required in the query in order to use the
+ # double property in sorting or as a facet.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
},
},
],
@@ -509,64 +567,6 @@
# The name must start with a letter and can only contain letters (A-Z, a-z)
# or numbers (0-9).
# The maximum length is 256 characters.
- "options": { # The options for an object. # The optional object-specific options.
- "freshnessOptions": { # Indicates which freshness property to use when adjusting search ranking for # The freshness options for an object.
- # an item. Fresher, more recent dates indicate higher quality. Use the
- # freshness option property that best works with your data. For fileshare
- # documents, last modified time is most relevant. For calendar event data,
- # the time when the event occurs is a more relevant freshness indicator. In
- # this way, calendar events that occur closer to the time of the search query
- # are considered higher quality and ranked accordingly.
- "freshnessDuration": "A String", # The duration after which an object should be considered
- # stale. The default value is 180 days (in seconds).
- "freshnessProperty": "A String", # This property indicates the freshness level of the object in the index.
- # If set, this property must be a top-level property within the
- # property definitions
- # and it must be a
- # timestamp type
- # or
- # date type.
- # Otherwise, the Indexing API uses
- # updateTime
- # as the freshness indicator.
- # The maximum length is 256 characters.
- #
- # When a property is used to calculate freshness, the value defaults
- # to 2 years from the current time.
- },
- "displayOptions": { # The display options for an object. # Options that determine how the object is displayed in the Cloud Search
- # results page.
- "objectDisplayLabel": "A String", # The user friendly label to display in the search result to indicate the
- # type of the item. This is OPTIONAL; if not provided, an object label isn't
- # displayed on the context line of the search results. The maximum length
- # is 64 characters.
- "metalines": [ # Defines the properties that are displayed in the metalines of the
- # search results. The property values are displayed in the order given
- # here. If a property holds multiple values, all of the values are
- # displayed before the next properties. For this reason, it is a good
- # practice to specify singular properties before repeated properties in this
- # list. All of the properties must set
- # is_returnable
- # to true. The maximum number of metalines is 3.
- { # A metaline is a list of properties that are displayed along with the search
- # result to provide context.
- "properties": [ # The list of displayed properties for the metaline. The maximum number of
- # properties is 5.
- { # A reference to a top-level property within the object that should be
- # displayed in search results. The values of the chosen properties is
- # displayed in the search results along with the
- # display label
- # for that property if one is specified. If a display label is not specified,
- # only the values is shown.
- "propertyName": "A String", # The name of the top-level property as defined in a property definition
- # for the object. If the name is not a defined property in the schema, an
- # error is given when attempting to update the schema.
- },
- ],
- },
- ],
- },
- },
},
],
}</pre>
@@ -587,6 +587,12 @@
The object takes the form of:
{
+ "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
+ "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
+ # Otherwise, ignore this field.
+ },
+ "validateOnly": True or False, # If true, the schema will be checked for validity,
+ # but will not be registered with the data source, even if valid.
"schema": { # The schema definition for a data source. # The new schema for the source.
"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
# schema. After modifying the schema, wait for operations to complete
@@ -596,206 +602,67 @@
"objectDefinitions": [ # The list of top-level objects for the data source.
# The maximum number of elements is 10.
{ # The definition for an object within a data source.
+ "options": { # The options for an object. # The optional object-specific options.
+ "displayOptions": { # The display options for an object. # Options that determine how the object is displayed in the Cloud Search
+ # results page.
+ "objectDisplayLabel": "A String", # The user friendly label to display in the search result to indicate the
+ # type of the item. This is OPTIONAL; if not provided, an object label isn't
+ # displayed on the context line of the search results. The maximum length
+ # is 64 characters.
+ "metalines": [ # Defines the properties that are displayed in the metalines of the
+ # search results. The property values are displayed in the order given
+ # here. If a property holds multiple values, all of the values are
+ # displayed before the next properties. For this reason, it is a good
+ # practice to specify singular properties before repeated properties in this
+ # list. All of the properties must set
+ # is_returnable
+ # to true. The maximum number of metalines is 3.
+ { # A metaline is a list of properties that are displayed along with the search
+ # result to provide context.
+ "properties": [ # The list of displayed properties for the metaline. The maximum number of
+ # properties is 5.
+ { # A reference to a top-level property within the object that should be
+ # displayed in search results. The values of the chosen properties is
+ # displayed in the search results along with the
+ # display label
+ # for that property if one is specified. If a display label is not specified,
+ # only the values is shown.
+ "propertyName": "A String", # The name of the top-level property as defined in a property definition
+ # for the object. If the name is not a defined property in the schema, an
+ # error is given when attempting to update the schema.
+ },
+ ],
+ },
+ ],
+ },
+ "freshnessOptions": { # Indicates which freshness property to use when adjusting search ranking for # The freshness options for an object.
+ # an item. Fresher, more recent dates indicate higher quality. Use the
+ # freshness option property that best works with your data. For fileshare
+ # documents, last modified time is most relevant. For calendar event data,
+ # the time when the event occurs is a more relevant freshness indicator. In
+ # this way, calendar events that occur closer to the time of the search query
+ # are considered higher quality and ranked accordingly.
+ "freshnessDuration": "A String", # The duration after which an object should be considered
+ # stale. The default value is 180 days (in seconds).
+ "freshnessProperty": "A String", # This property indicates the freshness level of the object in the index.
+ # If set, this property must be a top-level property within the
+ # property definitions
+ # and it must be a
+ # timestamp type
+ # or
+ # date type.
+ # Otherwise, the Indexing API uses
+ # updateTime
+ # as the freshness indicator.
+ # The maximum length is 256 characters.
+ #
+ # When a property is used to calculate freshness, the value defaults
+ # to 2 years from the current time.
+ },
+ },
"propertyDefinitions": [ # The property definitions for the object.
# The maximum number of elements is 1000.
{ # The definition of a property within an object.
- "enumPropertyOptions": { # Options for enum properties, which allow you to define a restricted set of
- # strings to match user queries, set rankings for those string values, and
- # define an operator name to be paired with those strings so that users can
- # narrow results to only items with a specific value. For example, for items in
- # a request tracking system with priority information, you could define *p0* as
- # an allowable enum value and tie this enum to the operator name *priority* so
- # that search users could add *priority:p0* to their query to restrict the set
- # of results to only those items indexed with the value *p0*.
- "orderedRanking": "A String", # Used to specify the ordered ranking for the enumeration that determines how
- # the integer values provided in the possible EnumValuePairs are used to rank
- # results. If specified, integer values must be provided for all possible
- # EnumValuePair values given for this property. Can only be used if
- # isRepeatable
- # is false.
- "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.
- # optional. Search operators let users restrict the query to specific fields
- # relevant to the type of item being searched. For example, if you provide no
- # operator for a *priority* enum property with possible values *p0* and *p1*,
- # a query that contains the term *p0* returns items that have *p0* as the
- # value of the *priority* property, as well as any items that contain the
- # string *p0* in other fields. If you provide an operator name for the enum,
- # such as *priority*, then search users can use that operator to refine
- # results to only items that have *p0* as this property's value, with the
- # query *priority:p0*.
- "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # enum property. For example, if operatorName is *priority* and the
- # property's name is *priorityVal*, then queries like
- # *priority:&lt;value&gt;* show results only where the value of the
- # property named *priorityVal* matches *&lt;value&gt;*. By contrast, a
- # search that uses the same *&lt;value&gt;* without an operator returns
- # all items where *&lt;value&gt;* matches the value of any String
- # properties or text within the content field for the item.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- "possibleValues": [ # The list of possible values for the enumeration property. All
- # EnumValuePairs must provide a string value. If you specify an integer value
- # for one EnumValuePair, then all possible EnumValuePairs must provide an
- # integer value. Both the string value and integer value must be unique over
- # all possible values. Once set, possible values cannot be removed or
- # modified. If you supply an ordered ranking and think you might insert
- # additional enum values in the future, leave gaps in the initial integer
- # values to allow adding a value in between previously registered values.
- # The maximum number of elements is 100.
- { # The enumeration value pair defines two things: a required string value and
- # an optional integer value. The string value defines the necessary query
- # term required to retrieve that item, such as *p0* for a priority item.
- # The integer value determines the ranking of that string value relative
- # to other enumerated values for the same property. For example, you might
- # associate *p0* with *0* and define another enum pair such as *p1* and *1*.
- # You must use the integer value in combination with
- # ordered
- # ranking to
- # set the ranking of a given value relative to other enumerated values for
- # the same property name. Here, a ranking order of DESCENDING for *priority*
- # properties results in a ranking boost for items indexed with a value of
- # *p0* compared to items indexed with a value of *p1*. Without a specified
- # ranking order, the integer value has no effect on item ranking.
- "integerValue": 42, # The integer value of the EnumValuePair which must be non-negative.
- # Optional.
- "stringValue": "A String", # The string value of the EnumValuePair.
- # The maximum length is 32 characters.
- },
- ],
- },
- "displayOptions": { # The display options for a property. # Options that determine how the property is displayed in the Cloud Search
- # results page if it is specified to be displayed in the object's
- # display options
- # .
- "displayLabel": "A String", # The user friendly label for the property that is used if the property
- # is specified to be displayed in ObjectDisplayOptions. If provided, the
- # display label is shown in front of the property values when the property is
- # part of the object display options. For example, if the property value is
- # '1', the value by itself may not be useful context for the user. If the
- # display name given was 'priority', then the user sees 'priority : 1' in
- # the search results which provides clear context to search users. This is
- # OPTIONAL; if not given, only the property values are displayed.
- # The maximum length is 64 characters.
- },
- "datePropertyOptions": { # Options for date properties.
- "operatorOptions": { # Optional. Provides a search operator for date properties. # If set, describes how the date should be used as a search operator.
- # Search operators let users restrict the query to specific fields relevant
- # to the type of item being searched.
- "operatorName": "A String", # Indicates the actual string required in the query in order to isolate the
- # date property. For example, suppose an issue tracking schema object
- # has a property named *closeDate* that specifies an operator with an
- # operatorName of *closedon*. For searches on that data, queries like
- # *closedon:&lt;value&gt;* show results only where the value of the
- # *closeDate* property matches *&lt;value&gt;*. By contrast, a
- # search that uses the same *&lt;value&gt;* without an operator returns
- # all items where *&lt;value&gt;* matches the value of any String
- # properties or text within the content field for the indexed datasource.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # date property using the greater-than operator. For example, if
- # greaterThanOperatorName is *closedafter* and the property's name is
- # *closeDate*, then queries like *closedafter:&lt;value&gt;*
- # show results only where the value of the property named *closeDate* is
- # later than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # date property using the less-than operator. For example, if
- # lessThanOperatorName is *closedbefore* and the property's name is
- # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
- # show results only where the value of the property named *closeDate* is
- # earlier than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- },
- "isFacetable": True or False, # Indicates that the property can be used for generating facets. Cannot be
- # true for properties whose type is object. IsReturnable must be true to set
- # this option.
- # Only supported for Boolean, Enum, and Text properties.
- "isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for
- # properties that are repeatable. Cannot be true for properties whose type
- # is object or user identifier. IsReturnable must be true to set this option.
- # Only supported for Boolean, Date, Double, Integer, and Timestamp
- # properties.
- "isReturnable": True or False, # Indicates that the property identifies data that should be returned in
- # search results via the Query API. If set to *true*, indicates that Query
- # API users can use matching property fields in results. However, storing
- # fields requires more space allocation and uses more bandwidth for search
- # queries, which impacts performance over large datasets. Set to *true* here
- # only if the field is needed for search results. Cannot be true for
- # properties whose type is an object.
- "name": "A String", # The name of the property. Item indexing requests sent to the Indexing API
- # should set the property name
- # equal to this value. For example, if name is *subject_line*, then indexing
- # requests for document items with subject fields should set the
- # name for that field equal to
- # *subject_line*. Use the name as the identifier for the object property.
- # Once registered as a property for an object, you cannot re-use this name
- # for another property within that object.
- # The name must start with a letter and can only contain letters (A-Z, a-z)
- # or numbers (0-9).
- # The maximum length is 256 characters.
- "booleanPropertyOptions": { # Options for boolean properties.
- "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.
- # optional. Search operators let users restrict the query to specific fields
- # relevant to the type of item being searched.
- "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # boolean property. For example, if operatorName is *closed* and the
- # property's name is *isClosed*, then queries like
- # *closed:&lt;value&gt;* show results only where the value of the
- # property named *isClosed* matches *&lt;value&gt;*. By contrast, a
- # search that uses the same *&lt;value&gt;* without an operator returns
- # all items where *&lt;value&gt;* matches the value of any
- # String properties or text within the content field for the item.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- },
- "timestampPropertyOptions": { # Options for timestamp properties.
- "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.
- # optional. Search operators let users restrict the query to specific fields
- # relevant to the type of item being searched.
- "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # timestamp property. For example, if operatorName is *closedon* and the
- # property's name is *closeDate*, then queries like
- # *closedon:&lt;value&gt;* show results only where the value of the
- # property named *closeDate* matches *&lt;value&gt;*. By contrast, a
- # search that uses the same *&lt;value&gt;* without an operator returns
- # all items where *&lt;value&gt;* matches the value of any String
- # properties or text within the content field for the item. The operator
- # name can only contain lowercase letters (a-z). The maximum length is 32
- # characters.
- "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # timestamp property using the greater-than operator. For example, if
- # greaterThanOperatorName is *closedafter* and the property's name is
- # *closeDate*, then queries like *closedafter:&lt;value&gt;*
- # show results only where the value of the property named *closeDate* is
- # later than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # timestamp property using the less-than operator. For example, if
- # lessThanOperatorName is *closedbefore* and the property's name is
- # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
- # show results only where the value of the property named *closeDate* is
- # earlier than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- },
- "doublePropertyOptions": { # Options for double properties.
- "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.
- # optional. Search operators let users restrict the query to specific fields
- # relevant to the type of item being searched.
- "operatorName": "A String", # Indicates the operator name required in the query in order to use the
- # double property in sorting or as a facet.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
- },
- },
"textPropertyOptions": { # Options for text properties.
"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.
# Search operators let users restrict the query to specific fields relevant
@@ -868,17 +735,17 @@
},
},
"integerPropertyOptions": { # Options for integer properties.
- "orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if
- # isRepeatable
- # is false.
- "maximumValue": "A String", # The maximum value of the property. The minimum and maximum values for the
- # property are used to rank results according to the
- # ordered ranking.
- # Indexing requests with values greater than the maximum are accepted and
- # ranked with the same weight as items indexed with the maximum value.
"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.
# optional. Search operators let users restrict the query to specific fields
# relevant to the type of item being searched.
+ "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # integer property using the less-than operator. For example, if
+ # lessThanOperatorName is *prioritybelow* and the property's name is
+ # *priorityVal*, then queries like *prioritybelow:&lt;value&gt;*
+ # show results only where the value of the property named *priorityVal* is
+ # less than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
# integer property. For example, if operatorName is *priority* and the
# property's name is *priorityVal*, then queries like
@@ -897,20 +764,217 @@
# greater than *&lt;value&gt;*.
# The operator name can only contain lowercase letters (a-z).
# The maximum length is 32 characters.
- "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
- # integer property using the less-than operator. For example, if
- # lessThanOperatorName is *prioritybelow* and the property's name is
- # *priorityVal*, then queries like *prioritybelow:&lt;value&gt;*
- # show results only where the value of the property named *priorityVal* is
- # less than *&lt;value&gt;*.
- # The operator name can only contain lowercase letters (a-z).
- # The maximum length is 32 characters.
},
"minimumValue": "A String", # The minimum value of the property. The minimum and maximum values for the
# property are used to rank results according to the
# ordered ranking.
# Indexing requests with values less than the minimum are accepted and
# ranked with the same weight as items indexed with the minimum value.
+ "orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if
+ # isRepeatable
+ # is false.
+ "maximumValue": "A String", # The maximum value of the property. The minimum and maximum values for the
+ # property are used to rank results according to the
+ # ordered ranking.
+ # Indexing requests with values greater than the maximum are accepted and
+ # ranked with the same weight as items indexed with the maximum value.
+ },
+ "enumPropertyOptions": { # Options for enum properties, which allow you to define a restricted set of
+ # strings to match user queries, set rankings for those string values, and
+ # define an operator name to be paired with those strings so that users can
+ # narrow results to only items with a specific value. For example, for items in
+ # a request tracking system with priority information, you could define *p0* as
+ # an allowable enum value and tie this enum to the operator name *priority* so
+ # that search users could add *priority:p0* to their query to restrict the set
+ # of results to only those items indexed with the value *p0*.
+ "possibleValues": [ # The list of possible values for the enumeration property. All
+ # EnumValuePairs must provide a string value. If you specify an integer value
+ # for one EnumValuePair, then all possible EnumValuePairs must provide an
+ # integer value. Both the string value and integer value must be unique over
+ # all possible values. Once set, possible values cannot be removed or
+ # modified. If you supply an ordered ranking and think you might insert
+ # additional enum values in the future, leave gaps in the initial integer
+ # values to allow adding a value in between previously registered values.
+ # The maximum number of elements is 100.
+ { # The enumeration value pair defines two things: a required string value and
+ # an optional integer value. The string value defines the necessary query
+ # term required to retrieve that item, such as *p0* for a priority item.
+ # The integer value determines the ranking of that string value relative
+ # to other enumerated values for the same property. For example, you might
+ # associate *p0* with *0* and define another enum pair such as *p1* and *1*.
+ # You must use the integer value in combination with
+ # ordered
+ # ranking to
+ # set the ranking of a given value relative to other enumerated values for
+ # the same property name. Here, a ranking order of DESCENDING for *priority*
+ # properties results in a ranking boost for items indexed with a value of
+ # *p0* compared to items indexed with a value of *p1*. Without a specified
+ # ranking order, the integer value has no effect on item ranking.
+ "integerValue": 42, # The integer value of the EnumValuePair which must be non-negative.
+ # Optional.
+ "stringValue": "A String", # The string value of the EnumValuePair.
+ # The maximum length is 32 characters.
+ },
+ ],
+ "orderedRanking": "A String", # Used to specify the ordered ranking for the enumeration that determines how
+ # the integer values provided in the possible EnumValuePairs are used to rank
+ # results. If specified, integer values must be provided for all possible
+ # EnumValuePair values given for this property. Can only be used if
+ # isRepeatable
+ # is false.
+ "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.
+ # optional. Search operators let users restrict the query to specific fields
+ # relevant to the type of item being searched. For example, if you provide no
+ # operator for a *priority* enum property with possible values *p0* and *p1*,
+ # a query that contains the term *p0* returns items that have *p0* as the
+ # value of the *priority* property, as well as any items that contain the
+ # string *p0* in other fields. If you provide an operator name for the enum,
+ # such as *priority*, then search users can use that operator to refine
+ # results to only items that have *p0* as this property's value, with the
+ # query *priority:p0*.
+ "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # enum property. For example, if operatorName is *priority* and the
+ # property's name is *priorityVal*, then queries like
+ # *priority:&lt;value&gt;* show results only where the value of the
+ # property named *priorityVal* matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator returns
+ # all items where *&lt;value&gt;* matches the value of any String
+ # properties or text within the content field for the item.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
+ },
+ "displayOptions": { # The display options for a property. # Options that determine how the property is displayed in the Cloud Search
+ # results page if it is specified to be displayed in the object's
+ # display options
+ # .
+ "displayLabel": "A String", # The user friendly label for the property that is used if the property
+ # is specified to be displayed in ObjectDisplayOptions. If provided, the
+ # display label is shown in front of the property values when the property is
+ # part of the object display options. For example, if the property value is
+ # '1', the value by itself may not be useful context for the user. If the
+ # display name given was 'priority', then the user sees 'priority : 1' in
+ # the search results which provides clear context to search users. This is
+ # OPTIONAL; if not given, only the property values are displayed.
+ # The maximum length is 64 characters.
+ },
+ "datePropertyOptions": { # Options for date properties.
+ "operatorOptions": { # Optional. Provides a search operator for date properties. # If set, describes how the date should be used as a search operator.
+ # Search operators let users restrict the query to specific fields relevant
+ # to the type of item being searched.
+ "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # date property using the greater-than operator. For example, if
+ # greaterThanOperatorName is *closedafter* and the property's name is
+ # *closeDate*, then queries like *closedafter:&lt;value&gt;*
+ # show results only where the value of the property named *closeDate* is
+ # later than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # date property using the less-than operator. For example, if
+ # lessThanOperatorName is *closedbefore* and the property's name is
+ # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
+ # show results only where the value of the property named *closeDate* is
+ # earlier than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ "operatorName": "A String", # Indicates the actual string required in the query in order to isolate the
+ # date property. For example, suppose an issue tracking schema object
+ # has a property named *closeDate* that specifies an operator with an
+ # operatorName of *closedon*. For searches on that data, queries like
+ # *closedon:&lt;value&gt;* show results only where the value of the
+ # *closeDate* property matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator returns
+ # all items where *&lt;value&gt;* matches the value of any String
+ # properties or text within the content field for the indexed datasource.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
+ },
+ "isFacetable": True or False, # Indicates that the property can be used for generating facets. Cannot be
+ # true for properties whose type is object. IsReturnable must be true to set
+ # this option.
+ # Only supported for Boolean, Enum, and Text properties.
+ "isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for
+ # properties that are repeatable. Cannot be true for properties whose type
+ # is object or user identifier. IsReturnable must be true to set this option.
+ # Only supported for Boolean, Date, Double, Integer, and Timestamp
+ # properties.
+ "isReturnable": True or False, # Indicates that the property identifies data that should be returned in
+ # search results via the Query API. If set to *true*, indicates that Query
+ # API users can use matching property fields in results. However, storing
+ # fields requires more space allocation and uses more bandwidth for search
+ # queries, which impacts performance over large datasets. Set to *true* here
+ # only if the field is needed for search results. Cannot be true for
+ # properties whose type is an object.
+ "name": "A String", # The name of the property. Item indexing requests sent to the Indexing API
+ # should set the property name
+ # equal to this value. For example, if name is *subject_line*, then indexing
+ # requests for document items with subject fields should set the
+ # name for that field equal to
+ # *subject_line*. Use the name as the identifier for the object property.
+ # Once registered as a property for an object, you cannot re-use this name
+ # for another property within that object.
+ # The name must start with a letter and can only contain letters (A-Z, a-z)
+ # or numbers (0-9).
+ # The maximum length is 256 characters.
+ "booleanPropertyOptions": { # Options for boolean properties.
+ "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.
+ # optional. Search operators let users restrict the query to specific fields
+ # relevant to the type of item being searched.
+ "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # boolean property. For example, if operatorName is *closed* and the
+ # property's name is *isClosed*, then queries like
+ # *closed:&lt;value&gt;* show results only where the value of the
+ # property named *isClosed* matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator returns
+ # all items where *&lt;value&gt;* matches the value of any
+ # String properties or text within the content field for the item.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
+ },
+ "timestampPropertyOptions": { # Options for timestamp properties.
+ "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.
+ # optional. Search operators let users restrict the query to specific fields
+ # relevant to the type of item being searched.
+ "lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # timestamp property using the less-than operator. For example, if
+ # lessThanOperatorName is *closedbefore* and the property's name is
+ # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
+ # show results only where the value of the property named *closeDate* is
+ # earlier than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ "operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # timestamp property. For example, if operatorName is *closedon* and the
+ # property's name is *closeDate*, then queries like
+ # *closedon:&lt;value&gt;* show results only where the value of the
+ # property named *closeDate* matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator returns
+ # all items where *&lt;value&gt;* matches the value of any String
+ # properties or text within the content field for the item. The operator
+ # name can only contain lowercase letters (a-z). The maximum length is 32
+ # characters.
+ "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # timestamp property using the greater-than operator. For example, if
+ # greaterThanOperatorName is *closedafter* and the property's name is
+ # *closeDate*, then queries like *closedafter:&lt;value&gt;*
+ # show results only where the value of the property named *closeDate* is
+ # later than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
+ },
+ "doublePropertyOptions": { # Options for double properties.
+ "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.
+ # optional. Search operators let users restrict the query to specific fields
+ # relevant to the type of item being searched.
+ "operatorName": "A String", # Indicates the operator name required in the query in order to use the
+ # double property in sorting or as a facet.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
+ },
},
},
],
@@ -924,73 +988,9 @@
# The name must start with a letter and can only contain letters (A-Z, a-z)
# or numbers (0-9).
# The maximum length is 256 characters.
- "options": { # The options for an object. # The optional object-specific options.
- "freshnessOptions": { # Indicates which freshness property to use when adjusting search ranking for # The freshness options for an object.
- # an item. Fresher, more recent dates indicate higher quality. Use the
- # freshness option property that best works with your data. For fileshare
- # documents, last modified time is most relevant. For calendar event data,
- # the time when the event occurs is a more relevant freshness indicator. In
- # this way, calendar events that occur closer to the time of the search query
- # are considered higher quality and ranked accordingly.
- "freshnessDuration": "A String", # The duration after which an object should be considered
- # stale. The default value is 180 days (in seconds).
- "freshnessProperty": "A String", # This property indicates the freshness level of the object in the index.
- # If set, this property must be a top-level property within the
- # property definitions
- # and it must be a
- # timestamp type
- # or
- # date type.
- # Otherwise, the Indexing API uses
- # updateTime
- # as the freshness indicator.
- # The maximum length is 256 characters.
- #
- # When a property is used to calculate freshness, the value defaults
- # to 2 years from the current time.
- },
- "displayOptions": { # The display options for an object. # Options that determine how the object is displayed in the Cloud Search
- # results page.
- "objectDisplayLabel": "A String", # The user friendly label to display in the search result to indicate the
- # type of the item. This is OPTIONAL; if not provided, an object label isn't
- # displayed on the context line of the search results. The maximum length
- # is 64 characters.
- "metalines": [ # Defines the properties that are displayed in the metalines of the
- # search results. The property values are displayed in the order given
- # here. If a property holds multiple values, all of the values are
- # displayed before the next properties. For this reason, it is a good
- # practice to specify singular properties before repeated properties in this
- # list. All of the properties must set
- # is_returnable
- # to true. The maximum number of metalines is 3.
- { # A metaline is a list of properties that are displayed along with the search
- # result to provide context.
- "properties": [ # The list of displayed properties for the metaline. The maximum number of
- # properties is 5.
- { # A reference to a top-level property within the object that should be
- # displayed in search results. The values of the chosen properties is
- # displayed in the search results along with the
- # display label
- # for that property if one is specified. If a display label is not specified,
- # only the values is shown.
- "propertyName": "A String", # The name of the top-level property as defined in a property definition
- # for the object. If the name is not a defined property in the schema, an
- # error is given when attempting to update the schema.
- },
- ],
- },
- ],
- },
- },
},
],
},
- "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
- "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
- # Otherwise, ignore this field.
- },
- "validateOnly": True or False, # If true, the schema will be checked for validity,
- # but will not be registered with the data source, even if valid.
}
x__xgafv: string, V1 error format.
@@ -1003,9 +1003,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -1043,6 +1040,9 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
}</pre>
</div>