Class ConversationalSearchRequest.SearchParams.Builder (2.64.0)

public static final class ConversationalSearchRequest.SearchParams.Builder extends GeneratedMessageV3.Builder<ConversationalSearchRequest.SearchParams.Builder> implements ConversationalSearchRequest.SearchParamsOrBuilder

Search parameters.

Protobuf type google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ConversationalSearchRequest.SearchParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides

build()

public ConversationalSearchRequest.SearchParams build()
Returns
Type Description
ConversationalSearchRequest.SearchParams

buildPartial()

public ConversationalSearchRequest.SearchParams buildPartial()
Returns
Type Description
ConversationalSearchRequest.SearchParams

clear()

public ConversationalSearchRequest.SearchParams.Builder clear()
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides

clearBoostSpec()

public ConversationalSearchRequest.SearchParams.Builder clearBoostSpec()

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
ConversationalSearchRequest.SearchParams.Builder

clearCanonicalFilter()

public ConversationalSearchRequest.SearchParams.Builder clearCanonicalFilter()

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
ConversationalSearchRequest.SearchParams.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ConversationalSearchRequest.SearchParams.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides

clearFilter()

public ConversationalSearchRequest.SearchParams.Builder clearFilter()

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
ConversationalSearchRequest.SearchParams.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ConversationalSearchRequest.SearchParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides

clearSortBy()

public ConversationalSearchRequest.SearchParams.Builder clearSortBy()

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
ConversationalSearchRequest.SearchParams.Builder

This builder for chaining.

clone()

public ConversationalSearchRequest.SearchParams.Builder clone()
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides

getBoostSpec()

public 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.

getBoostSpecBuilder()

public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()

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.Builder

getBoostSpecOrBuilder()

public 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 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 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.

getDefaultInstanceForType()

public ConversationalSearchRequest.SearchParams getDefaultInstanceForType()
Returns
Type Description
ConversationalSearchRequest.SearchParams

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBoostSpec(SearchRequest.BoostSpec value)

public ConversationalSearchRequest.SearchParams.Builder mergeBoostSpec(SearchRequest.BoostSpec value)

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];

Parameter
Name Description
value SearchRequest.BoostSpec
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

mergeFrom(ConversationalSearchRequest.SearchParams other)

public ConversationalSearchRequest.SearchParams.Builder mergeFrom(ConversationalSearchRequest.SearchParams other)
Parameter
Name Description
other ConversationalSearchRequest.SearchParams
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConversationalSearchRequest.SearchParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ConversationalSearchRequest.SearchParams.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ConversationalSearchRequest.SearchParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides

setBoostSpec(SearchRequest.BoostSpec value)

public ConversationalSearchRequest.SearchParams.Builder setBoostSpec(SearchRequest.BoostSpec value)

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];

Parameter
Name Description
value SearchRequest.BoostSpec
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

public ConversationalSearchRequest.SearchParams.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

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];

Parameter
Name Description
builderForValue SearchRequest.BoostSpec.Builder
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

setCanonicalFilter(String value)

public ConversationalSearchRequest.SearchParams.Builder setCanonicalFilter(String value)

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];

Parameter
Name Description
value String

The canonicalFilter to set.

Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

This builder for chaining.

setCanonicalFilterBytes(ByteString value)

public ConversationalSearchRequest.SearchParams.Builder setCanonicalFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for canonicalFilter to set.

Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ConversationalSearchRequest.SearchParams.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides

setFilter(String value)

public ConversationalSearchRequest.SearchParams.Builder setFilter(String value)

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];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ConversationalSearchRequest.SearchParams.Builder setFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ConversationalSearchRequest.SearchParams.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides

setSortBy(String value)

public ConversationalSearchRequest.SearchParams.Builder setSortBy(String value)

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];

Parameter
Name Description
value String

The sortBy to set.

Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

This builder for chaining.

setSortByBytes(ByteString value)

public ConversationalSearchRequest.SearchParams.Builder setSortByBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for sortBy to set.

Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ConversationalSearchRequest.SearchParams.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConversationalSearchRequest.SearchParams.Builder
Overrides