Class SearchRequest.CustomRankingParams.Builder (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class SearchRequest.CustomRankingParams.Builder extends GeneratedMessage.Builder<SearchRequest.CustomRankingParams.Builder> implements SearchRequest.CustomRankingParamsOrBuilder

Configuration parameters for the Custom Ranking feature.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.CustomRankingParams

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchRequest.CustomRankingParams.Builder

Implements

SearchRequest.CustomRankingParamsOrBuilder

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

addAllExpressionsToPrecompute(Iterable<String> values)

public SearchRequest.CustomRankingParams.Builder addAllExpressionsToPrecompute(Iterable<String> values)

Optional. A list of ranking expressions (see ranking_expression for the syntax documentation) to evaluate. The evaluation results will be returned in SearchResponse.SearchResult.rank_signals.precomputed_expression_values field.

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

Parameter
Name	Description
values	Iterable<String> The expressionsToPrecompute to add.

Returns
Type	Description
SearchRequest.CustomRankingParams.Builder	This builder for chaining.

addExpressionsToPrecompute(String value)

public SearchRequest.CustomRankingParams.Builder addExpressionsToPrecompute(String value)

Optional. A list of ranking expressions (see ranking_expression for the syntax documentation) to evaluate. The evaluation results will be returned in SearchResponse.SearchResult.rank_signals.precomputed_expression_values field.

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

Parameter
Name	Description
value	String The expressionsToPrecompute to add.

Returns
Type	Description
SearchRequest.CustomRankingParams.Builder	This builder for chaining.

addExpressionsToPrecomputeBytes(ByteString value)

public SearchRequest.CustomRankingParams.Builder addExpressionsToPrecomputeBytes(ByteString value)

Optional. A list of ranking expressions (see ranking_expression for the syntax documentation) to evaluate. The evaluation results will be returned in SearchResponse.SearchResult.rank_signals.precomputed_expression_values field.

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

Parameter
Name	Description
value	ByteString The bytes of the expressionsToPrecompute to add.

Returns
Type	Description
SearchRequest.CustomRankingParams.Builder	This builder for chaining.

build()

public SearchRequest.CustomRankingParams build()

Returns
Type	Description
SearchRequest.CustomRankingParams

buildPartial()

public SearchRequest.CustomRankingParams buildPartial()

Returns
Type	Description
SearchRequest.CustomRankingParams

clear()

public SearchRequest.CustomRankingParams.Builder clear()

Returns
Type	Description
SearchRequest.CustomRankingParams.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearExpressionsToPrecompute()

public SearchRequest.CustomRankingParams.Builder clearExpressionsToPrecompute()

Optional. A list of ranking expressions (see ranking_expression for the syntax documentation) to evaluate. The evaluation results will be returned in SearchResponse.SearchResult.rank_signals.precomputed_expression_values field.

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

Returns
Type	Description
SearchRequest.CustomRankingParams.Builder	This builder for chaining.

getDefaultInstanceForType()

public SearchRequest.CustomRankingParams getDefaultInstanceForType()

Returns
Type	Description
SearchRequest.CustomRankingParams

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getExpressionsToPrecompute(int index)

public String getExpressionsToPrecompute(int index)

Optional. A list of ranking expressions (see ranking_expression for the syntax documentation) to evaluate. The evaluation results will be returned in SearchResponse.SearchResult.rank_signals.precomputed_expression_values field.

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

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The expressionsToPrecompute at the given index.

getExpressionsToPrecomputeBytes(int index)

public ByteString getExpressionsToPrecomputeBytes(int index)

Optional. A list of ranking expressions (see ranking_expression for the syntax documentation) to evaluate. The evaluation results will be returned in SearchResponse.SearchResult.rank_signals.precomputed_expression_values field.

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

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the expressionsToPrecompute at the given index.

getExpressionsToPrecomputeCount()

public int getExpressionsToPrecomputeCount()

Optional. A list of ranking expressions (see ranking_expression for the syntax documentation) to evaluate. The evaluation results will be returned in SearchResponse.SearchResult.rank_signals.precomputed_expression_values field.

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

Returns
Type	Description
int	The count of expressionsToPrecompute.

getExpressionsToPrecomputeList()

public ProtocolStringList getExpressionsToPrecomputeList()

Optional. A list of ranking expressions (see ranking_expression for the syntax documentation) to evaluate. The evaluation results will be returned in SearchResponse.SearchResult.rank_signals.precomputed_expression_values field.

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

Returns
Type	Description
ProtocolStringList	A list containing the expressionsToPrecompute.

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

mergeFrom(SearchRequest.CustomRankingParams other)

public SearchRequest.CustomRankingParams.Builder mergeFrom(SearchRequest.CustomRankingParams other)

Parameter
Name	Description
other	SearchRequest.CustomRankingParams

Returns
Type	Description
SearchRequest.CustomRankingParams.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.CustomRankingParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.CustomRankingParams.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchRequest.CustomRankingParams.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchRequest.CustomRankingParams.Builder

Overrides

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

setExpressionsToPrecompute(int index, String value)

public SearchRequest.CustomRankingParams.Builder setExpressionsToPrecompute(int index, String value)

Optional. A list of ranking expressions (see ranking_expression for the syntax documentation) to evaluate. The evaluation results will be returned in SearchResponse.SearchResult.rank_signals.precomputed_expression_values field.

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

Parameters
Name	Description
index	int The index to set the value at.
value	String The expressionsToPrecompute to set.

Returns
Type	Description
SearchRequest.CustomRankingParams.Builder	This builder for chaining.