Class CatalogAttribute.FacetConfig.RerankConfig.Builder (2.53.0)

public static final class CatalogAttribute.FacetConfig.RerankConfig.Builder extends GeneratedMessageV3.Builder<CatalogAttribute.FacetConfig.RerankConfig.Builder> implements CatalogAttribute.FacetConfig.RerankConfigOrBuilder

Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don't pass the facet keys engaged that you want to rerank on, this control won't be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces).

Protobuf type google.cloud.retail.v2.CatalogAttribute.FacetConfig.RerankConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CatalogAttribute.FacetConfig.RerankConfig.Builder

Implements

CatalogAttribute.FacetConfig.RerankConfigOrBuilder

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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

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

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addAllFacetValues(Iterable<String> values)

public CatalogAttribute.FacetConfig.RerankConfig.Builder addAllFacetValues(Iterable<String> values)

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

repeated string facet_values = 2;

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

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`	This builder for chaining.

addFacetValues(String value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder addFacetValues(String value)

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

repeated string facet_values = 2;

Parameter
Name	Description
`value`	`String` The facetValues to add.

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`	This builder for chaining.

addFacetValuesBytes(ByteString value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder addFacetValuesBytes(ByteString value)

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

repeated string facet_values = 2;

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

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CatalogAttribute.FacetConfig.RerankConfig build()

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig`

buildPartial()

public CatalogAttribute.FacetConfig.RerankConfig buildPartial()

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig`

clear()

public CatalogAttribute.FacetConfig.RerankConfig.Builder clear()

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearFacetValues()

public CatalogAttribute.FacetConfig.RerankConfig.Builder clearFacetValues()

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

repeated string facet_values = 2;

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CatalogAttribute.FacetConfig.RerankConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CatalogAttribute.FacetConfig.RerankConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRerankFacet()

public CatalogAttribute.FacetConfig.RerankConfig.Builder clearRerankFacet()

If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.

bool rerank_facet = 1;

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`	This builder for chaining.

clone()

public CatalogAttribute.FacetConfig.RerankConfig.Builder clone()

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public CatalogAttribute.FacetConfig.RerankConfig getDefaultInstanceForType()

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFacetValues(int index)

public String getFacetValues(int index)

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

repeated string facet_values = 2;

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

Returns
Type	Description
`String`	The facetValues at the given index.

getFacetValuesBytes(int index)

public ByteString getFacetValuesBytes(int index)

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

repeated string facet_values = 2;

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

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

getFacetValuesCount()

public int getFacetValuesCount()

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

repeated string facet_values = 2;

Returns
Type	Description
`int`	The count of facetValues.

getFacetValuesList()

public ProtocolStringList getFacetValuesList()

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

repeated string facet_values = 2;

Returns
Type	Description
`ProtocolStringList`	A list containing the facetValues.

getRerankFacet()

public boolean getRerankFacet()

If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.

bool rerank_facet = 1;

Returns
Type	Description
`boolean`	The rerankFacet.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CatalogAttribute.FacetConfig.RerankConfig other)

public CatalogAttribute.FacetConfig.RerankConfig.Builder mergeFrom(CatalogAttribute.FacetConfig.RerankConfig other)

Parameter
Name	Description
`other`	`CatalogAttribute.FacetConfig.RerankConfig`

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CatalogAttribute.FacetConfig.RerankConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public CatalogAttribute.FacetConfig.RerankConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CatalogAttribute.FacetConfig.RerankConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setFacetValues(int index, String value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder setFacetValues(int index, String value)

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

repeated string facet_values = 2;

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

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

public CatalogAttribute.FacetConfig.RerankConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRerankFacet(boolean value)

public CatalogAttribute.FacetConfig.RerankConfig.Builder setRerankFacet(boolean value)

If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.

bool rerank_facet = 1;

Parameter
Name	Description
`value`	`boolean` The rerankFacet to set.

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CatalogAttribute.FacetConfig.RerankConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`CatalogAttribute.FacetConfig.RerankConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)