chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.html b/docs/dyn/cloudsearch_v1.indexing.datasources.html
index d69abee..4baea84 100644
--- a/docs/dyn/cloudsearch_v1.indexing.datasources.html
+++ b/docs/dyn/cloudsearch_v1.indexing.datasources.html
@@ -86,13 +86,15 @@
<code><a href="#getSchema">getSchema(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the schema of a data source.</p>
<p class="toc_element">
- <code><a href="#updateSchema">updateSchema(name, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates the schema of a data source.</p>
+ <code><a href="#updateSchema">updateSchema(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the schema of a data source. This method does not perform</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="deleteSchema">deleteSchema(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Deletes the schema of a data source.
+**Note:** This API requires an admin or service account to execute.
+
Args:
name: string, Name of the data source to delete Schema. Format:
datasources/{source_id} (required)
@@ -114,6 +116,22 @@
# 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.
+ "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
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
"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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -132,22 +150,6 @@
},
],
},
- "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
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -155,6 +157,8 @@
<code class="details" id="getSchema">getSchema(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Gets the schema of a data source.
+**Note:** This API requires an admin or service account to execute.
+
Args:
name: string, Name of the data source to get Schema. Format:
datasources/{source_id} (required)
@@ -188,15 +192,19 @@
"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
# html property. For example, if operatorName is *subject* and the
# property's name is *subjectLine*, then queries like
- # *subject:<value>* will show results only where the value of the
- # property named *subjectLine* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any
+ # *subject:&lt;value&gt;* show results only where the value of the
+ # property named *subjectLine* matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator return
+ # all items where *&lt;value&gt;* matches the value of any
# html 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.
},
},
+ "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this
+ # property. Only supported for Text properties. IsReturnable must be true to
+ # set this option. In a given datasource maximum of 5 properties can be
+ # marked as is_wildcard_searchable.
"textPropertyOptions": { # Options for text properties.
"retrievalImportance": { # Indicates the search quality importance of the tokens within the
# field when used for retrieval.
@@ -207,22 +215,22 @@
"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
# to the type of item being searched.
- "exactMatchWithOperator": True or False, # If true, the text value will be tokenized as one atomic value in
+ "exactMatchWithOperator": True or False, # If true, the text value is tokenized as one atomic value in
# operator searches and facet matches. For example, if the operator name is
# "genre" and the value is "science-fiction" the query restrictions
- # "genre:science" and "genre:fiction" will not match the item;
- # "genre:science-fiction" will. Value matching is case-sensitive
+ # "genre:science" and "genre:fiction" doesn't match the item;
+ # "genre:science-fiction" does. Value matching is case-sensitive
# and does not remove special characters.
- # If false, the text will be tokenized. For example, if the value is
- # "science-fiction" the queries "genre:science" and "genre:fiction" will
- # match the item.
+ # If false, the text is tokenized. For example, if the value is
+ # "science-fiction" the queries "genre:science" and "genre:fiction"
+ # matches the item.
"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
# text property. For example, if operatorName is *subject* and the
# property's name is *subjectLine*, then queries like
- # *subject:<value>* will show results only where the value of the
- # property named *subjectLine* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any
+ # *subject:&lt;value&gt;* show results only where the value of the
+ # property named *subjectLine* 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
# text 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.
@@ -247,33 +255,6 @@
# 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* will return 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:<value>* will show results only where the value of the
- # property named *priorityVal* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* 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
@@ -303,6 +284,33 @@
# Optional.
},
],
+ "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.
+ },
+ "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.
},
"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
@@ -311,18 +319,20 @@
# 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.
- "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.
- "objectPropertyOptions": { # Options for object properties.
- "subobjectProperties": [ # The properties of the sub-object. These properties represent a nested
- # object. For example, if this property represents a postal address, the
- # subobjectProperties might be named *street*, *city*, and *state*.
- # The maximum number of elements is 1000.
- # Object with schema name: PropertyDefinition
- ],
+ "isRepeatable": True or False, # Indicates that multiple values are allowed for the property. For example, a
+ # document only has one description but can have multiple comments. Cannot be
+ # true for properties whose type is a boolean.
+ # If set to false, properties that contain more than one value cause the
+ # indexing request for that item to be rejected.
+ "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.
+ },
},
"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.
@@ -331,27 +341,27 @@
"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:<value>* will
+ # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
# show results only where the value of the property named *closeDate* is
- # earlier than *<value>*.
+ # 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:<value>* will show results only where the value of the
- # property named *closeDate* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any String
+ # *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:<value>* will
+ # *closeDate*, then queries like *closedafter:&lt;value&gt;*
# show results only where the value of the property named *closeDate* is
- # later than *<value>*.
+ # later than *&lt;value&gt;*.
# The operator name can only contain lowercase letters (a-z).
# The maximum length is 32 characters.
},
@@ -363,46 +373,37 @@
"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:<value>* will
+ # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
# show results only where the value of the property named *closeDate* is
- # earlier than *<value>*.
+ # 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:<value>* will show results only where the value of the
- # *closeDate* property matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any String
+ # *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:<value>* will
+ # *closeDate*, then queries like *closedafter:&lt;value&gt;*
# show results only where the value of the property named *closeDate* is
- # later than *<value>*.
+ # later than *&lt;value&gt;*.
# 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 will be used if the property
- # is specified to be displayed in ObjectDisplayOptions. If given, the display
- # label will be 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 will see 'priority : 1' in
- # the search results which provides clear conext to search users. This is
- # OPTIONAL; if not given, only the property values will be displayed.
- # The maximum length is 32 characters.
- },
+ "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.
"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
@@ -410,10 +411,10 @@
"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:<value>* will show results only where the value of the
- # property named *isClosed* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any
+ # *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.
@@ -423,27 +424,29 @@
# true for properties whose type is object. IsReturnable must be true to set
# this option.
# Only supported for Boolean, Enum, and Text properties.
- "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.
- },
+ "isSuggestable": True or False, # Indicates that the property can be used for generating query suggestions.
+ "objectPropertyOptions": { # Options for object properties.
+ "subobjectProperties": [ # The properties of the sub-object. These properties represent a nested
+ # object. For example, if this property represents a postal address, the
+ # subobjectProperties might be named *street*, *city*, and *state*.
+ # The maximum number of elements is 1000.
+ # Object with schema name: PropertyDefinition
+ ],
},
- "isRepeatable": True or False, # Indicates that multiple values are allowed for the property. For example, a
- # document only has one description but can have multiple comments. Cannot be
- # true for properties whose type is a boolean.
- # If set to false, properties that contain more than one value will cause the
- # indexing request for that item to be rejected.
- "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this
- # property. Only supported for Text properties. IsReturnable must be true to
- # set this option. In a given datasource maximum of 5 properties can be
- # marked as is_wildcard_searchable.
- #
- # Note: This is an alpha feature and is enabled for whitelisted users only.
+ "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 32 characters.
+ },
"integerPropertyOptions": { # Options for integer properties.
"orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if
# isRepeatable
@@ -459,29 +462,29 @@
"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:<value>* will
+ # *priorityVal*, then queries like *prioritybelow:&lt;value&gt;*
# show results only where the value of the property named *priorityVal* is
- # less than *<value>*.
- # 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
- # integer property using the greater-than operator. For example, if
- # greaterThanOperatorName is *priorityabove* and the property's name is
- # *priorityVal*, then queries like *priorityabove:<value>* will
- # show results only where the value of the property named *priorityVal* is
- # greater than *<value>*.
+ # 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
- # *priority:<value>* will show results only where the value of the
- # property named *priorityVal* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any String
+ # *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.
+ "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # integer property using the greater-than operator. For example, if
+ # greaterThanOperatorName is *priorityabove* and the property's name is
+ # *priorityVal*, then queries like *priorityabove:&lt;value&gt;*
+ # show results only where the value of the property named *priorityVal* is
+ # greater than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
},
"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
@@ -491,16 +494,6 @@
},
},
],
- "name": "A String", # Name for the object, which then defines its type. Item indexing requests
- # should set the
- # objectType field
- # equal to this value. For example, if *name* is *Document*, then indexing
- # requests for items of type Document should set
- # objectType equal to
- # *Document*. Each object definition must be uniquely named within a schema.
- # 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
@@ -523,42 +516,52 @@
# as the freshness indicator.
# The maximum length is 256 characters.
#
- # When a property is used to calculate fresheness, the value defaults
+ # 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.
- "metalines": [ # Defines the properties that will be displayed in the metalines of the
- # search results. The property values will be displayed in the order given
- # here. If a property holds multiple values, all of the values will be
- # diplayed 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
+ "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 maxiumum number of
+ "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 will be
+ # displayed in search results. The values of the chosen properties is
# displayed in the search results along with the
- # dislpay label
+ # display label
# for that property if one is specified. If a display label is not specified,
- # only the values will be shown.
+ # 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 will be given when attempting to update the schema.
+ # error is given when attempting to update the schema.
},
],
},
],
- "objectDisplayLabel": "A String", # The user friendly label to display in the search result to inidicate the
- # type of the item. This is OPTIONAL; if not given, an object label will not
- # be displayed on the context line of the search results. The maximum length
+ "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 32 characters.
},
},
+ "name": "A String", # Name for the object, which then defines its type. Item indexing requests
+ # should set the
+ # objectType field
+ # equal to this value. For example, if *name* is *Document*, then indexing
+ # requests for items of type Document should set
+ # objectType equal to
+ # *Document*. Each object definition must be uniquely named within a schema.
+ # 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.
},
],
"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
@@ -570,17 +573,22 @@
</div>
<div class="method">
- <code class="details" id="updateSchema">updateSchema(name, body, x__xgafv=None)</code>
- <pre>Updates the schema of a data source.
+ <code class="details" id="updateSchema">updateSchema(name, body=None, x__xgafv=None)</code>
+ <pre>Updates the schema of a data source. This method does not perform
+incremental updates to the schema. Instead, this method updates the schema
+by overwriting the entire schema.
+
+**Note:** This API requires an admin or service account to execute.
Args:
name: string, Name of the data source to update Schema. Format:
datasources/{source_id} (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{
- "validateOnly": True or False, # If true, the request will be validated without side effects.
+ "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.
"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.
@@ -605,15 +613,19 @@
"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
# html property. For example, if operatorName is *subject* and the
# property's name is *subjectLine*, then queries like
- # *subject:<value>* will show results only where the value of the
- # property named *subjectLine* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any
+ # *subject:&lt;value&gt;* show results only where the value of the
+ # property named *subjectLine* matches *&lt;value&gt;*. By contrast, a
+ # search that uses the same *&lt;value&gt;* without an operator return
+ # all items where *&lt;value&gt;* matches the value of any
# html 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.
},
},
+ "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this
+ # property. Only supported for Text properties. IsReturnable must be true to
+ # set this option. In a given datasource maximum of 5 properties can be
+ # marked as is_wildcard_searchable.
"textPropertyOptions": { # Options for text properties.
"retrievalImportance": { # Indicates the search quality importance of the tokens within the
# field when used for retrieval.
@@ -624,22 +636,22 @@
"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
# to the type of item being searched.
- "exactMatchWithOperator": True or False, # If true, the text value will be tokenized as one atomic value in
+ "exactMatchWithOperator": True or False, # If true, the text value is tokenized as one atomic value in
# operator searches and facet matches. For example, if the operator name is
# "genre" and the value is "science-fiction" the query restrictions
- # "genre:science" and "genre:fiction" will not match the item;
- # "genre:science-fiction" will. Value matching is case-sensitive
+ # "genre:science" and "genre:fiction" doesn't match the item;
+ # "genre:science-fiction" does. Value matching is case-sensitive
# and does not remove special characters.
- # If false, the text will be tokenized. For example, if the value is
- # "science-fiction" the queries "genre:science" and "genre:fiction" will
- # match the item.
+ # If false, the text is tokenized. For example, if the value is
+ # "science-fiction" the queries "genre:science" and "genre:fiction"
+ # matches the item.
"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the
# text property. For example, if operatorName is *subject* and the
# property's name is *subjectLine*, then queries like
- # *subject:<value>* will show results only where the value of the
- # property named *subjectLine* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any
+ # *subject:&lt;value&gt;* show results only where the value of the
+ # property named *subjectLine* 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
# text 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.
@@ -664,33 +676,6 @@
# 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* will return 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:<value>* will show results only where the value of the
- # property named *priorityVal* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* 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
@@ -720,6 +705,33 @@
# Optional.
},
],
+ "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.
+ },
+ "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.
},
"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
@@ -728,18 +740,20 @@
# 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.
- "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.
- "objectPropertyOptions": { # Options for object properties.
- "subobjectProperties": [ # The properties of the sub-object. These properties represent a nested
- # object. For example, if this property represents a postal address, the
- # subobjectProperties might be named *street*, *city*, and *state*.
- # The maximum number of elements is 1000.
- # Object with schema name: PropertyDefinition
- ],
+ "isRepeatable": True or False, # Indicates that multiple values are allowed for the property. For example, a
+ # document only has one description but can have multiple comments. Cannot be
+ # true for properties whose type is a boolean.
+ # If set to false, properties that contain more than one value cause the
+ # indexing request for that item to be rejected.
+ "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.
+ },
},
"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.
@@ -748,27 +762,27 @@
"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:<value>* will
+ # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
# show results only where the value of the property named *closeDate* is
- # earlier than *<value>*.
+ # 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:<value>* will show results only where the value of the
- # property named *closeDate* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any String
+ # *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:<value>* will
+ # *closeDate*, then queries like *closedafter:&lt;value&gt;*
# show results only where the value of the property named *closeDate* is
- # later than *<value>*.
+ # later than *&lt;value&gt;*.
# The operator name can only contain lowercase letters (a-z).
# The maximum length is 32 characters.
},
@@ -780,46 +794,37 @@
"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:<value>* will
+ # *closeDate*, then queries like *closedbefore:&lt;value&gt;*
# show results only where the value of the property named *closeDate* is
- # earlier than *<value>*.
+ # 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:<value>* will show results only where the value of the
- # *closeDate* property matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any String
+ # *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:<value>* will
+ # *closeDate*, then queries like *closedafter:&lt;value&gt;*
# show results only where the value of the property named *closeDate* is
- # later than *<value>*.
+ # later than *&lt;value&gt;*.
# 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 will be used if the property
- # is specified to be displayed in ObjectDisplayOptions. If given, the display
- # label will be 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 will see 'priority : 1' in
- # the search results which provides clear conext to search users. This is
- # OPTIONAL; if not given, only the property values will be displayed.
- # The maximum length is 32 characters.
- },
+ "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.
"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
@@ -827,10 +832,10 @@
"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:<value>* will show results only where the value of the
- # property named *isClosed* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any
+ # *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.
@@ -840,27 +845,29 @@
# true for properties whose type is object. IsReturnable must be true to set
# this option.
# Only supported for Boolean, Enum, and Text properties.
- "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.
- },
+ "isSuggestable": True or False, # Indicates that the property can be used for generating query suggestions.
+ "objectPropertyOptions": { # Options for object properties.
+ "subobjectProperties": [ # The properties of the sub-object. These properties represent a nested
+ # object. For example, if this property represents a postal address, the
+ # subobjectProperties might be named *street*, *city*, and *state*.
+ # The maximum number of elements is 1000.
+ # Object with schema name: PropertyDefinition
+ ],
},
- "isRepeatable": True or False, # Indicates that multiple values are allowed for the property. For example, a
- # document only has one description but can have multiple comments. Cannot be
- # true for properties whose type is a boolean.
- # If set to false, properties that contain more than one value will cause the
- # indexing request for that item to be rejected.
- "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this
- # property. Only supported for Text properties. IsReturnable must be true to
- # set this option. In a given datasource maximum of 5 properties can be
- # marked as is_wildcard_searchable.
- #
- # Note: This is an alpha feature and is enabled for whitelisted users only.
+ "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 32 characters.
+ },
"integerPropertyOptions": { # Options for integer properties.
"orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if
# isRepeatable
@@ -876,29 +883,29 @@
"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:<value>* will
+ # *priorityVal*, then queries like *prioritybelow:&lt;value&gt;*
# show results only where the value of the property named *priorityVal* is
- # less than *<value>*.
- # 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
- # integer property using the greater-than operator. For example, if
- # greaterThanOperatorName is *priorityabove* and the property's name is
- # *priorityVal*, then queries like *priorityabove:<value>* will
- # show results only where the value of the property named *priorityVal* is
- # greater than *<value>*.
+ # 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
- # *priority:<value>* will show results only where the value of the
- # property named *priorityVal* matches *<value>*. By contrast, a
- # search that uses the same *<value>* without an operator will return
- # all items where *<value>* matches the value of any String
+ # *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.
+ "greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the
+ # integer property using the greater-than operator. For example, if
+ # greaterThanOperatorName is *priorityabove* and the property's name is
+ # *priorityVal*, then queries like *priorityabove:&lt;value&gt;*
+ # show results only where the value of the property named *priorityVal* is
+ # greater than *&lt;value&gt;*.
+ # The operator name can only contain lowercase letters (a-z).
+ # The maximum length is 32 characters.
},
"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
@@ -908,16 +915,6 @@
},
},
],
- "name": "A String", # Name for the object, which then defines its type. Item indexing requests
- # should set the
- # objectType field
- # equal to this value. For example, if *name* is *Document*, then indexing
- # requests for items of type Document should set
- # objectType equal to
- # *Document*. Each object definition must be uniquely named within a schema.
- # 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
@@ -940,42 +937,52 @@
# as the freshness indicator.
# The maximum length is 256 characters.
#
- # When a property is used to calculate fresheness, the value defaults
+ # 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.
- "metalines": [ # Defines the properties that will be displayed in the metalines of the
- # search results. The property values will be displayed in the order given
- # here. If a property holds multiple values, all of the values will be
- # diplayed 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
+ "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 maxiumum number of
+ "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 will be
+ # displayed in search results. The values of the chosen properties is
# displayed in the search results along with the
- # dislpay label
+ # display label
# for that property if one is specified. If a display label is not specified,
- # only the values will be shown.
+ # 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 will be given when attempting to update the schema.
+ # error is given when attempting to update the schema.
},
],
},
],
- "objectDisplayLabel": "A String", # The user friendly label to display in the search result to inidicate the
- # type of the item. This is OPTIONAL; if not given, an object label will not
- # be displayed on the context line of the search results. The maximum length
+ "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 32 characters.
},
},
+ "name": "A String", # Name for the object, which then defines its type. Item indexing requests
+ # should set the
+ # objectType field
+ # equal to this value. For example, if *name* is *Document*, then indexing
+ # requests for items of type Document should set
+ # objectType equal to
+ # *Document*. Each object definition must be uniquely named within a schema.
+ # 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.
},
],
"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
@@ -1002,6 +1009,22 @@
# 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.
+ "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
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
"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.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -1020,22 +1043,6 @@
},
],
},
- "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
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>