Class ConversationalSearchRequest.SearchParams.Builder (2.89.0)

2.89.0 (latest) 2.87.0 2.85.0 2.84.0 2.82.0 2.80.0 2.78.0 2.77.0 2.76.0 2.75.0 2.74.0 2.72.0 2.70.0 2.69.0 2.66.0 2.65.0 2.64.0 2.62.0 2.61.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.53.0 2.51.0 2.50.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.1 2.4.0 2.3.0 2.2.3 2.1.0 2.0.19

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

Search parameters.

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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ConversationalSearchRequest.SearchParams.Builder

Implements

ConversationalSearchRequest.SearchParamsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

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

GeneratedMessage.Builder<BuilderType>.clear()

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

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.

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.

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

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.v2beta.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the boostSpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

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.

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.