Interface ConversationalSearchRequest.SearchParamsOrBuilder (2.64.0)

public static interface ConversationalSearchRequest.SearchParamsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoostSpec()

public abstract SearchRequest.BoostSpec getBoostSpec()

Optional. The boost spec to specify the boosting of search results.

The syntax of the boost spec is the same as SearchRequest.boost_spec.

.google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchRequest.BoostSpec

The boostSpec.

getBoostSpecOrBuilder()

public abstract SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

Optional. The boost spec to specify the boosting of search results.

The syntax of the boost spec is the same as SearchRequest.boost_spec.

.google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchRequest.BoostSpecOrBuilder

getCanonicalFilter()

public abstract String getCanonicalFilter()

Optional. The canonical filter string to restrict search results.

The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.

string canonical_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The canonicalFilter.

getCanonicalFilterBytes()

public abstract ByteString getCanonicalFilterBytes()

Optional. The canonical filter string to restrict search results.

The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.

string canonical_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for canonicalFilter.

getFilter()

public abstract String getFilter()

Optional. The filter string to restrict search results.

The syntax of the filter string is the same as SearchRequest.filter.

string filter = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. The filter string to restrict search results.

The syntax of the filter string is the same as SearchRequest.filter.

string filter = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getSortBy()

public abstract String getSortBy()

Optional. The sort string to specify the sorting of search results.

The syntax of the sort string is the same as [SearchRequest.sort][].

string sort_by = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sortBy.

getSortByBytes()

public abstract ByteString getSortByBytes()

Optional. The sort string to specify the sorting of search results.

The syntax of the sort string is the same as [SearchRequest.sort][].

string sort_by = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sortBy.

hasBoostSpec()

public abstract boolean hasBoostSpec()

Optional. The boost spec to specify the boosting of search results.

The syntax of the boost spec is the same as SearchRequest.boost_spec.

.google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the boostSpec field is set.