Skip to content

Commit 6a63e51

Browse files
feat(cloudsearch): update the api
#### cloudsearch:v1 The following keys were added: - resources.stats.methods.getSearchapplication (Total Keys: 25) - schemas.CustomerSearchApplicationStats (Total Keys: 5) - schemas.GetCustomerIndexStatsResponse.properties.averageIndexedItemCount (Total Keys: 2) - schemas.GetCustomerQueryStatsResponse.properties.totalQueryCount (Total Keys: 2) - schemas.GetCustomerSearchApplicationStatsResponse (Total Keys: 6) - schemas.GetDataSourceIndexStatsResponse.properties.averageIndexedItemCount (Total Keys: 2) - schemas.GetSearchApplicationQueryStatsResponse.properties.totalQueryCount (Total Keys: 2) - schemas.ItemCountByStatus.properties.indexedItemsCount (Total Keys: 2)
1 parent ebe2edc commit 6a63e51

9 files changed

+188
-10
lines changed

docs/dyn/cloudsearch_v1.debug.datasources.items.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ <h3>Method Details</h3>
324324
],
325325
},
326326
},
327-
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
327+
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item.
328328
},
329329
],
330330
&quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.

docs/dyn/cloudsearch_v1.indexing.datasources.items.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h3>Method Details</h3>
126126
UNSPECIFIED - Priority is not specified in the update request. Leaving priority unspecified results in an update failure.
127127
SYNCHRONOUS - For real-time updates.
128128
ASYNCHRONOUS - For changes that are executed after the response is sent back to the caller.
129-
version: string, Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
129+
version: string, Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item.
130130
x__xgafv: string, V1 error format.
131131
Allowed values
132132
1 - v1 error format
@@ -385,7 +385,7 @@ <h3>Method Details</h3>
385385
],
386386
},
387387
},
388-
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
388+
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item.
389389
}</pre>
390390
</div>
391391

@@ -573,7 +573,7 @@ <h3>Method Details</h3>
573573
],
574574
},
575575
},
576-
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
576+
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item.
577577
},
578578
&quot;mode&quot;: &quot;A String&quot;, # Required. The RequestMode for this request.
579579
}
@@ -795,7 +795,7 @@ <h3>Method Details</h3>
795795
],
796796
},
797797
},
798-
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
798+
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item.
799799
},
800800
],
801801
&quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
@@ -1014,7 +1014,7 @@ <h3>Method Details</h3>
10141014
],
10151015
},
10161016
},
1017-
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
1017+
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item.
10181018
},
10191019
],
10201020
}</pre>
@@ -1224,7 +1224,7 @@ <h3>Method Details</h3>
12241224
],
12251225
},
12261226
},
1227-
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
1227+
&quot;version&quot;: &quot;A String&quot;, # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won&#x27;t index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/guides/operations) to understand how item version affects reindexing after delete item.
12281228
}</pre>
12291229
</div>
12301230

docs/dyn/cloudsearch_v1.query.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,7 @@ <h3>Method Details</h3>
392392
&quot;name&quot;: &quot;A String&quot;, # Source name for content indexed by the Indexing API.
393393
&quot;predefinedSource&quot;: &quot;A String&quot;, # Predefined content source for Google Apps.
394394
},
395+
&quot;thumbnailUrl&quot;: &quot;A String&quot;, # The thumbnail URL of the result.
395396
&quot;updateTime&quot;: &quot;A String&quot;, # The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.
396397
},
397398
&quot;snippet&quot;: { # Snippet of the search result, which summarizes the content of the resulting page. # The concatenation of all snippets (summaries) available for this result.

docs/dyn/cloudsearch_v1.settings.datasources.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ <h3>Method Details</h3>
127127
&quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
128128
&quot;A String&quot;,
129129
],
130+
&quot;returnThumbnailUrls&quot;: True or False, # Can a user request to get thumbnail URI for Items indexed in this data source.
130131
&quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the &#x27;source&#x27; operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
131132
}
132133

@@ -228,6 +229,7 @@ <h3>Method Details</h3>
228229
&quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
229230
&quot;A String&quot;,
230231
],
232+
&quot;returnThumbnailUrls&quot;: True or False, # Can a user request to get thumbnail URI for Items indexed in this data source.
231233
&quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the &#x27;source&#x27; operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
232234
}</pre>
233235
</div>
@@ -269,6 +271,7 @@ <h3>Method Details</h3>
269271
&quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
270272
&quot;A String&quot;,
271273
],
274+
&quot;returnThumbnailUrls&quot;: True or False, # Can a user request to get thumbnail URI for Items indexed in this data source.
272275
&quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the &#x27;source&#x27; operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
273276
},
274277
],
@@ -320,6 +323,7 @@ <h3>Method Details</h3>
320323
&quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this schema.
321324
&quot;A String&quot;,
322325
],
326+
&quot;returnThumbnailUrls&quot;: True or False, # Can a user request to get thumbnail URI for Items indexed in this data source.
323327
&quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source. This value will be used to match the &#x27;source&#x27; operator. For example, if the short name is *&lt;value&gt;* then queries like *source:&lt;value&gt;* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with &#x27;google&#x27; and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
324328
},
325329
}

docs/dyn/cloudsearch_v1.settings.searchapplications.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ <h3>Method Details</h3>
171171
&quot;forceDisableSupplementalResults&quot;: True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
172172
&quot;forceVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
173173
},
174+
&quot;returnResultThumbnailUrls&quot;: True or False, # With each result we should return the URI for its thumbnail (when applicable)
174175
&quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
175176
&quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
176177
&quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
@@ -331,6 +332,7 @@ <h3>Method Details</h3>
331332
&quot;forceDisableSupplementalResults&quot;: True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
332333
&quot;forceVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
333334
},
335+
&quot;returnResultThumbnailUrls&quot;: True or False, # With each result we should return the URI for its thumbnail (when applicable)
334336
&quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
335337
&quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
336338
&quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
@@ -431,6 +433,7 @@ <h3>Method Details</h3>
431433
&quot;forceDisableSupplementalResults&quot;: True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
432434
&quot;forceVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
433435
},
436+
&quot;returnResultThumbnailUrls&quot;: True or False, # With each result we should return the URI for its thumbnail (when applicable)
434437
&quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
435438
&quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
436439
&quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.
@@ -581,6 +584,7 @@ <h3>Method Details</h3>
581584
&quot;forceDisableSupplementalResults&quot;: True or False, # Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.
582585
&quot;forceVerbatimMode&quot;: True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.
583586
},
587+
&quot;returnResultThumbnailUrls&quot;: True or False, # With each result we should return the URI for its thumbnail (when applicable)
584588
&quot;scoringConfig&quot;: { # Scoring configurations for a source while processing a Search or Suggest request. # Configuration for ranking results.
585589
&quot;disableFreshness&quot;: True or False, # Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.
586590
&quot;disablePersonalization&quot;: True or False, # Whether to personalize the results. By default, personal signals will be used to boost results.

0 commit comments

Comments
 (0)