Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class ConversationalSearchRequest.SearchParams (2.85.0)

public static final class ConversationalSearchRequest.SearchParams extends GeneratedMessage implements ConversationalSearchRequest.SearchParamsOrBuilder

Search parameters.

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

Inheritance

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

Implements

ConversationalSearchRequest.SearchParamsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static ConversationalSearchRequest.SearchParams.Builder newBuilder()

Returns
Type	Description
`ConversationalSearchRequest.SearchParams.Builder`

newBuilder(ConversationalSearchRequest.SearchParams prototype)

public static ConversationalSearchRequest.SearchParams.Builder newBuilder(ConversationalSearchRequest.SearchParams prototype)

Parameter
Name	Description
`prototype`	`ConversationalSearchRequest.SearchParams`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams.Builder`

parseDelimitedFrom(InputStream input)

public static ConversationalSearchRequest.SearchParams parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.SearchParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static ConversationalSearchRequest.SearchParams parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.SearchParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static ConversationalSearchRequest.SearchParams parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.SearchParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static ConversationalSearchRequest.SearchParams parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.SearchParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static ConversationalSearchRequest.SearchParams parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.SearchParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static ConversationalSearchRequest.SearchParams parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.SearchParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<ConversationalSearchRequest.SearchParams> parser()

Returns
Type	Description
`Parser<SearchParams>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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.

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`

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()

Returns
Type	Description
`Parser<SearchParams>`

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

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()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public ConversationalSearchRequest.SearchParams.Builder newBuilderForType()

Returns
Type	Description
`ConversationalSearchRequest.SearchParams.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ConversationalSearchRequest.SearchParams.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`ConversationalSearchRequest.SearchParams.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ConversationalSearchRequest.SearchParams.Builder toBuilder()

Returns
Type	Description
`ConversationalSearchRequest.SearchParams.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`