Skip to content

Commit

Permalink
docs: remove remaining private links (#85)
Browse files Browse the repository at this point in the history
* docs: remove remaining private links

PiperOrigin-RevId: 387857950

Source-Link: googleapis/googleapis@dc93323

Source-Link: googleapis/googleapis-gen@072b1e8

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/master/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Aug 2, 2021
1 parent a6b9129 commit f233c3d
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 116 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -545,8 +545,7 @@ message SearchRequest {

// The filter syntax consists of an expression language for constructing a
// predicate from one or more fields of the products being filtered. Filter
// expression is case-sensitive. See more details at this [user
// guide](/retail/private/docs/filter-and-order#filter).
// expression is case-sensitive.
//
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string filter = 10;
Expand All @@ -564,9 +563,7 @@ message SearchRequest {

// The order in which products are returned. Products can be ordered by
// a field in an [Product][google.cloud.retail.v2.Product] object. Leave it
// unset if ordered by relevance. OrderBy expression is case-sensitive. See
// more details at this [user
// guide](/retail/private/docs/filter-and-order#order).
// unset if ordered by relevance. OrderBy expression is case-sensitive.
//
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 11;
Expand All @@ -585,13 +582,11 @@ message SearchRequest {
// facet feature.
DynamicFacetSpec dynamic_facet_spec = 21;

// Boost specification to boost certain products. See more details at this
// [user guide](/retail/private/docs/boosting).
// Boost specification to boost certain products.
BoostSpec boost_spec = 13;

// The query expansion specification that specifies the conditions under which
// query expansion will occur. See more details at this [user
// guide](/retail/private/docs/result-size#query_expansion).
// query expansion will occur.
QueryExpansionSpec query_expansion_spec = 14;

// The keys to fetch and rollup the matching
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -570,8 +570,7 @@ message SearchRequest {

// The filter syntax consists of an expression language for constructing a
// predicate from one or more fields of the products being filtered. Filter
// expression is case-sensitive. See more details at this [user
// guide](/retail/private/docs/filter-and-order#filter).
// expression is case-sensitive.
//
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string filter = 10;
Expand All @@ -590,9 +589,7 @@ message SearchRequest {

// The order in which products are returned. Products can be ordered by
// a field in an [Product][google.cloud.retail.v2alpha.Product] object. Leave
// it unset if ordered by relevance. OrderBy expression is case-sensitive. See
// more details at this [user
// guide](/retail/private/docs/filter-and-order#order).
// it unset if ordered by relevance. OrderBy expression is case-sensitive.
//
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 11;
Expand All @@ -611,22 +608,19 @@ message SearchRequest {
// facet feature.
DynamicFacetSpec dynamic_facet_spec = 21;

// Boost specification to boost certain products. See more details at this
// [user guide](/retail/private/docs/boosting).
// Boost specification to boost certain products.
BoostSpec boost_spec = 13;

// The query expansion specification that specifies the conditions under which
// query expansion will occur. See more details at this [user
// guide](/retail/private/docs/result-size#query_expansion).
// query expansion will occur.
QueryExpansionSpec query_expansion_spec = 14;

// The relevance threshold of the search results.
//
// Defaults to
// [RelevanceThreshold.HIGH][google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold.HIGH],
// which means only the most relevant results are shown, and the least number
// of results are returned. See more details at this [user
// guide](/retail/private/docs/result-size#relevance_thresholding).
// of results are returned.
RelevanceThreshold relevance_threshold = 15;

// The keys to fetch and rollup the matching
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -548,8 +548,7 @@ message SearchRequest {

// The filter syntax consists of an expression language for constructing a
// predicate from one or more fields of the products being filtered. Filter
// expression is case-sensitive. See more details at this [user
// guide](/retail/private/docs/filter-and-order#filter).
// expression is case-sensitive.
//
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string filter = 10;
Expand All @@ -567,9 +566,7 @@ message SearchRequest {

// The order in which products are returned. Products can be ordered by
// a field in an [Product][google.cloud.retail.v2beta.Product] object. Leave
// it unset if ordered by relevance. OrderBy expression is case-sensitive. See
// more details at this [user
// guide](/retail/private/docs/filter-and-order#order).
// it unset if ordered by relevance. OrderBy expression is case-sensitive.
//
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 11;
Expand All @@ -588,13 +585,11 @@ message SearchRequest {
// facet feature.
DynamicFacetSpec dynamic_facet_spec = 21;

// Boost specification to boost certain products. See more details at this
// [user guide](/retail/private/docs/boosting).
// Boost specification to boost certain products.
BoostSpec boost_spec = 13;

// The query expansion specification that specifies the conditions under which
// query expansion will occur. See more details at this [user
// guide](/retail/private/docs/result-size#query_expansion).
// query expansion will occur.
QueryExpansionSpec query_expansion_spec = 14;

// The keys to fetch and rollup the matching
Expand Down
39 changes: 12 additions & 27 deletions packages/google-cloud-retail/src/v2/search_service_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -407,8 +407,7 @@ export class SearchServiceClient {
* @param {string} request.filter
* The filter syntax consists of an expression language for constructing a
* predicate from one or more fields of the products being filtered. Filter
* expression is case-sensitive. See more details at this [user
* guide](/retail/private/docs/filter-and-order#filter).
* expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {string} request.canonicalFilter
Expand All @@ -424,9 +423,7 @@ export class SearchServiceClient {
* @param {string} request.orderBy
* The order in which products are returned. Products can be ordered by
* a field in an {@link google.cloud.retail.v2.Product|Product} object. Leave it
* unset if ordered by relevance. OrderBy expression is case-sensitive. See
* more details at this [user
* guide](/retail/private/docs/filter-and-order#order).
* unset if ordered by relevance. OrderBy expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {number[]} request.facetSpecs
Expand All @@ -442,12 +439,10 @@ export class SearchServiceClient {
* ([email protected]) if you are interested in using dynamic
* facet feature.
* @param {google.cloud.retail.v2.SearchRequest.BoostSpec} request.boostSpec
* Boost specification to boost certain products. See more details at this
* [user guide](/retail/private/docs/boosting).
* Boost specification to boost certain products.
* @param {google.cloud.retail.v2.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
* The query expansion specification that specifies the conditions under which
* query expansion will occur. See more details at this [user
* guide](/retail/private/docs/result-size#query_expansion).
* query expansion will occur.
* @param {string[]} request.variantRollupKeys
* The keys to fetch and rollup the matching
* {@link google.cloud.retail.v2.Product.Type.VARIANT|variant}
Expand Down Expand Up @@ -618,8 +613,7 @@ export class SearchServiceClient {
* @param {string} request.filter
* The filter syntax consists of an expression language for constructing a
* predicate from one or more fields of the products being filtered. Filter
* expression is case-sensitive. See more details at this [user
* guide](/retail/private/docs/filter-and-order#filter).
* expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {string} request.canonicalFilter
Expand All @@ -635,9 +629,7 @@ export class SearchServiceClient {
* @param {string} request.orderBy
* The order in which products are returned. Products can be ordered by
* a field in an {@link google.cloud.retail.v2.Product|Product} object. Leave it
* unset if ordered by relevance. OrderBy expression is case-sensitive. See
* more details at this [user
* guide](/retail/private/docs/filter-and-order#order).
* unset if ordered by relevance. OrderBy expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {number[]} request.facetSpecs
Expand All @@ -653,12 +645,10 @@ export class SearchServiceClient {
* ([email protected]) if you are interested in using dynamic
* facet feature.
* @param {google.cloud.retail.v2.SearchRequest.BoostSpec} request.boostSpec
* Boost specification to boost certain products. See more details at this
* [user guide](/retail/private/docs/boosting).
* Boost specification to boost certain products.
* @param {google.cloud.retail.v2.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
* The query expansion specification that specifies the conditions under which
* query expansion will occur. See more details at this [user
* guide](/retail/private/docs/result-size#query_expansion).
* query expansion will occur.
* @param {string[]} request.variantRollupKeys
* The keys to fetch and rollup the matching
* {@link google.cloud.retail.v2.Product.Type.VARIANT|variant}
Expand Down Expand Up @@ -811,8 +801,7 @@ export class SearchServiceClient {
* @param {string} request.filter
* The filter syntax consists of an expression language for constructing a
* predicate from one or more fields of the products being filtered. Filter
* expression is case-sensitive. See more details at this [user
* guide](/retail/private/docs/filter-and-order#filter).
* expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {string} request.canonicalFilter
Expand All @@ -828,9 +817,7 @@ export class SearchServiceClient {
* @param {string} request.orderBy
* The order in which products are returned. Products can be ordered by
* a field in an {@link google.cloud.retail.v2.Product|Product} object. Leave it
* unset if ordered by relevance. OrderBy expression is case-sensitive. See
* more details at this [user
* guide](/retail/private/docs/filter-and-order#order).
* unset if ordered by relevance. OrderBy expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {number[]} request.facetSpecs
Expand All @@ -846,12 +833,10 @@ export class SearchServiceClient {
* ([email protected]) if you are interested in using dynamic
* facet feature.
* @param {google.cloud.retail.v2.SearchRequest.BoostSpec} request.boostSpec
* Boost specification to boost certain products. See more details at this
* [user guide](/retail/private/docs/boosting).
* Boost specification to boost certain products.
* @param {google.cloud.retail.v2.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
* The query expansion specification that specifies the conditions under which
* query expansion will occur. See more details at this [user
* guide](/retail/private/docs/result-size#query_expansion).
* query expansion will occur.
* @param {string[]} request.variantRollupKeys
* The keys to fetch and rollup the matching
* {@link google.cloud.retail.v2.Product.Type.VARIANT|variant}
Expand Down
48 changes: 15 additions & 33 deletions packages/google-cloud-retail/src/v2alpha/search_service_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,7 @@ export class SearchServiceClient {
* @param {string} request.filter
* The filter syntax consists of an expression language for constructing a
* predicate from one or more fields of the products being filtered. Filter
* expression is case-sensitive. See more details at this [user
* guide](/retail/private/docs/filter-and-order#filter).
* expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {string} request.canonicalFilter
Expand All @@ -426,9 +425,7 @@ export class SearchServiceClient {
* @param {string} request.orderBy
* The order in which products are returned. Products can be ordered by
* a field in an {@link google.cloud.retail.v2alpha.Product|Product} object. Leave
* it unset if ordered by relevance. OrderBy expression is case-sensitive. See
* more details at this [user
* guide](/retail/private/docs/filter-and-order#order).
* it unset if ordered by relevance. OrderBy expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {number[]} request.facetSpecs
Expand All @@ -444,20 +441,17 @@ export class SearchServiceClient {
* ([email protected]) if you are interested in using dynamic
* facet feature.
* @param {google.cloud.retail.v2alpha.SearchRequest.BoostSpec} request.boostSpec
* Boost specification to boost certain products. See more details at this
* [user guide](/retail/private/docs/boosting).
* Boost specification to boost certain products.
* @param {google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
* The query expansion specification that specifies the conditions under which
* query expansion will occur. See more details at this [user
* guide](/retail/private/docs/result-size#query_expansion).
* query expansion will occur.
* @param {google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
* The relevance threshold of the search results.
*
* Defaults to
* {@link google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold.HIGH|RelevanceThreshold.HIGH},
* which means only the most relevant results are shown, and the least number
* of results are returned. See more details at this [user
* guide](/retail/private/docs/result-size#relevance_thresholding).
* of results are returned.
* @param {string[]} request.variantRollupKeys
* The keys to fetch and rollup the matching
* {@link google.cloud.retail.v2alpha.Product.Type.VARIANT|variant}
Expand Down Expand Up @@ -631,8 +625,7 @@ export class SearchServiceClient {
* @param {string} request.filter
* The filter syntax consists of an expression language for constructing a
* predicate from one or more fields of the products being filtered. Filter
* expression is case-sensitive. See more details at this [user
* guide](/retail/private/docs/filter-and-order#filter).
* expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {string} request.canonicalFilter
Expand All @@ -649,9 +642,7 @@ export class SearchServiceClient {
* @param {string} request.orderBy
* The order in which products are returned. Products can be ordered by
* a field in an {@link google.cloud.retail.v2alpha.Product|Product} object. Leave
* it unset if ordered by relevance. OrderBy expression is case-sensitive. See
* more details at this [user
* guide](/retail/private/docs/filter-and-order#order).
* it unset if ordered by relevance. OrderBy expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {number[]} request.facetSpecs
Expand All @@ -667,20 +658,17 @@ export class SearchServiceClient {
* ([email protected]) if you are interested in using dynamic
* facet feature.
* @param {google.cloud.retail.v2alpha.SearchRequest.BoostSpec} request.boostSpec
* Boost specification to boost certain products. See more details at this
* [user guide](/retail/private/docs/boosting).
* Boost specification to boost certain products.
* @param {google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
* The query expansion specification that specifies the conditions under which
* query expansion will occur. See more details at this [user
* guide](/retail/private/docs/result-size#query_expansion).
* query expansion will occur.
* @param {google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
* The relevance threshold of the search results.
*
* Defaults to
* {@link google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold.HIGH|RelevanceThreshold.HIGH},
* which means only the most relevant results are shown, and the least number
* of results are returned. See more details at this [user
* guide](/retail/private/docs/result-size#relevance_thresholding).
* of results are returned.
* @param {string[]} request.variantRollupKeys
* The keys to fetch and rollup the matching
* {@link google.cloud.retail.v2alpha.Product.Type.VARIANT|variant}
Expand Down Expand Up @@ -836,8 +824,7 @@ export class SearchServiceClient {
* @param {string} request.filter
* The filter syntax consists of an expression language for constructing a
* predicate from one or more fields of the products being filtered. Filter
* expression is case-sensitive. See more details at this [user
* guide](/retail/private/docs/filter-and-order#filter).
* expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {string} request.canonicalFilter
Expand All @@ -854,9 +841,7 @@ export class SearchServiceClient {
* @param {string} request.orderBy
* The order in which products are returned. Products can be ordered by
* a field in an {@link google.cloud.retail.v2alpha.Product|Product} object. Leave
* it unset if ordered by relevance. OrderBy expression is case-sensitive. See
* more details at this [user
* guide](/retail/private/docs/filter-and-order#order).
* it unset if ordered by relevance. OrderBy expression is case-sensitive.
*
* If this field is unrecognizable, an INVALID_ARGUMENT is returned.
* @param {number[]} request.facetSpecs
Expand All @@ -872,20 +857,17 @@ export class SearchServiceClient {
* ([email protected]) if you are interested in using dynamic
* facet feature.
* @param {google.cloud.retail.v2alpha.SearchRequest.BoostSpec} request.boostSpec
* Boost specification to boost certain products. See more details at this
* [user guide](/retail/private/docs/boosting).
* Boost specification to boost certain products.
* @param {google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
* The query expansion specification that specifies the conditions under which
* query expansion will occur. See more details at this [user
* guide](/retail/private/docs/result-size#query_expansion).
* query expansion will occur.
* @param {google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
* The relevance threshold of the search results.
*
* Defaults to
* {@link google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold.HIGH|RelevanceThreshold.HIGH},
* which means only the most relevant results are shown, and the least number
* of results are returned. See more details at this [user
* guide](/retail/private/docs/result-size#relevance_thresholding).
* of results are returned.
* @param {string[]} request.variantRollupKeys
* The keys to fetch and rollup the matching
* {@link google.cloud.retail.v2alpha.Product.Type.VARIANT|variant}
Expand Down
Loading

0 comments on commit f233c3d

Please sign in to comment.