Send feedback
Class ConversationalSearchRequest.SearchParams (2.64.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public static final class ConversationalSearchRequest . SearchParams extends GeneratedMessageV3 implements ConversationalSearchRequest . SearchParamsOrBuilder
Search parameters.
Protobuf type google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BOOST_SPEC_FIELD_NUMBER
public static final int BOOST_SPEC_FIELD_NUMBER
Field Value
Type
Description
int
CANONICAL_FILTER_FIELD_NUMBER
public static final int CANONICAL_FILTER_FIELD_NUMBER
Field Value
Type
Description
int
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type
Description
int
SORT_BY_FIELD_NUMBER
public static final int SORT_BY_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static ConversationalSearchRequest . SearchParams getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ConversationalSearchRequest . SearchParams . Builder newBuilder ()
newBuilder(ConversationalSearchRequest.SearchParams prototype)
public static ConversationalSearchRequest . SearchParams . Builder newBuilder ( ConversationalSearchRequest . SearchParams prototype )
public static ConversationalSearchRequest . SearchParams parseDelimitedFrom ( InputStream input )
public static ConversationalSearchRequest . SearchParams parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ConversationalSearchRequest . SearchParams parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ConversationalSearchRequest . SearchParams parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ConversationalSearchRequest . SearchParams parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ConversationalSearchRequest . SearchParams parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ConversationalSearchRequest . SearchParams parseFrom ( CodedInputStream input )
public static ConversationalSearchRequest . SearchParams parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ConversationalSearchRequest . SearchParams parseFrom ( InputStream input )
public static ConversationalSearchRequest . SearchParams parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ConversationalSearchRequest . SearchParams parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ConversationalSearchRequest . SearchParams parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ConversationalSearchRequest . SearchParams > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
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];
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];
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 ()
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.
getParserForType()
public Parser<ConversationalSearchRequest . SearchParams > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
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.
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ConversationalSearchRequest . SearchParams . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ConversationalSearchRequest . SearchParams . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public ConversationalSearchRequest . SearchParams . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-15 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-15 UTC."],[],[]]