Class ServingConfig (2.35.0)

Version 2.35.0

• 2.57.0 (latest)
• 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 final class ServingConfig extends GeneratedMessageV3 implements ServingConfigOrBuilder

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).

Protobuf type google.cloud.retail.v2alpha.ServingConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ServingConfig

Implements

ServingConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

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

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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

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

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

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

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

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

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

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

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

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

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

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BOOST_CONTROL_IDS_FIELD_NUMBER

public static final int BOOST_CONTROL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

DIVERSITY_LEVEL_FIELD_NUMBER

public static final int DIVERSITY_LEVEL_FIELD_NUMBER

Field Value
Type	Description
int

DIVERSITY_TYPE_FIELD_NUMBER

public static final int DIVERSITY_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

DO_NOT_ASSOCIATE_CONTROL_IDS_FIELD_NUMBER

public static final int DO_NOT_ASSOCIATE_CONTROL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

DYNAMIC_FACET_SPEC_FIELD_NUMBER

public static final int DYNAMIC_FACET_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_CATEGORY_FILTER_LEVEL_FIELD_NUMBER

public static final int ENABLE_CATEGORY_FILTER_LEVEL_FIELD_NUMBER

Field Value
Type	Description
int

FACET_CONTROL_IDS_FIELD_NUMBER

public static final int FACET_CONTROL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

FILTER_CONTROL_IDS_FIELD_NUMBER

public static final int FILTER_CONTROL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

IGNORE_CONTROL_IDS_FIELD_NUMBER

public static final int IGNORE_CONTROL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

MODEL_ID_FIELD_NUMBER

public static final int MODEL_ID_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER

public static final int ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

PERSONALIZATION_SPEC_FIELD_NUMBER

public static final int PERSONALIZATION_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

PRICE_RERANKING_LEVEL_FIELD_NUMBER

public static final int PRICE_RERANKING_LEVEL_FIELD_NUMBER

Field Value
Type	Description
int

REDIRECT_CONTROL_IDS_FIELD_NUMBER

public static final int REDIRECT_CONTROL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

REPLACEMENT_CONTROL_IDS_FIELD_NUMBER

public static final int REPLACEMENT_CONTROL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

SOLUTION_TYPES_FIELD_NUMBER

public static final int SOLUTION_TYPES_FIELD_NUMBER

Field Value
Type	Description
int

TWOWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER

public static final int TWOWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ServingConfig getDefaultInstance()

Returns
Type	Description
ServingConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ServingConfig.Builder newBuilder()

Returns
Type	Description
ServingConfig.Builder

newBuilder(ServingConfig prototype)

public static ServingConfig.Builder newBuilder(ServingConfig prototype)

Parameter
Name	Description
prototype	ServingConfig

Returns
Type	Description
ServingConfig.Builder

parseDelimitedFrom(InputStream input)

public static ServingConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ServingConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ServingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ServingConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ServingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ServingConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ServingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ServingConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ServingConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ServingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ServingConfig> parser()

Returns
Type	Description
Parser<ServingConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getBoostControlIds(int index)

public String getBoostControlIds(int index)

Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100.

Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string boost_control_ids = 7;

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

Returns
Type	Description
String	The boostControlIds at the given index.

getBoostControlIdsBytes(int index)

public ByteString getBoostControlIdsBytes(int index)

Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100.

Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string boost_control_ids = 7;

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

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

getBoostControlIdsCount()

public int getBoostControlIdsCount()

Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100.

Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string boost_control_ids = 7;

Returns
Type	Description
int	The count of boostControlIds.

getBoostControlIdsList()

public ProtocolStringList getBoostControlIdsList()

Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100.

Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string boost_control_ids = 7;

Returns
Type	Description
ProtocolStringList	A list containing the boostControlIds.

getDefaultInstanceForType()

public ServingConfig getDefaultInstanceForType()

Returns
Type	Description
ServingConfig

getDisplayName()

public String getDisplayName()

Required. The human readable serving config display name. Used in Retail UI.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The human readable serving config display name. Used in Retail UI.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getDiversityLevel()

public String getDiversityLevel()

How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values:

• no-diversity
• low-diversity
• medium-diversity
• high-diversity

• auto-diversity

  If not specified, we choose default based on recommendation model type. Default value: no-diversity.

  Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.

string diversity_level = 8;

Returns
Type	Description
String	The diversityLevel.

getDiversityLevelBytes()

public ByteString getDiversityLevelBytes()

How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values:

• no-diversity
• low-diversity
• medium-diversity
• high-diversity

• auto-diversity

  If not specified, we choose default based on recommendation model type. Default value: no-diversity.

  Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.

string diversity_level = 8;

Returns
Type	Description
ByteString	The bytes for diversityLevel.

getDiversityType()

public ServingConfig.DiversityType getDiversityType()

What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.

.google.cloud.retail.v2alpha.ServingConfig.DiversityType diversity_type = 20;

Returns
Type	Description
ServingConfig.DiversityType	The diversityType.

getDiversityTypeValue()

public int getDiversityTypeValue()

What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.

.google.cloud.retail.v2alpha.ServingConfig.DiversityType diversity_type = 20;

Returns
Type	Description
int	The enum numeric value on the wire for diversityType.

getDoNotAssociateControlIds(int index)

public String getDoNotAssociateControlIds(int index)

Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string do_not_associate_control_ids = 13;

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

Returns
Type	Description
String	The doNotAssociateControlIds at the given index.

getDoNotAssociateControlIdsBytes(int index)

public ByteString getDoNotAssociateControlIdsBytes(int index)

Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string do_not_associate_control_ids = 13;

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

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

getDoNotAssociateControlIdsCount()

public int getDoNotAssociateControlIdsCount()

Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string do_not_associate_control_ids = 13;

Returns
Type	Description
int	The count of doNotAssociateControlIds.

getDoNotAssociateControlIdsList()

public ProtocolStringList getDoNotAssociateControlIdsList()

Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string do_not_associate_control_ids = 13;

Returns
Type	Description
ProtocolStringList	A list containing the doNotAssociateControlIds.

getDynamicFacetSpec()

public SearchRequest.DynamicFacetSpec getDynamicFacetSpec()

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

.google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;

Returns
Type	Description
SearchRequest.DynamicFacetSpec	The dynamicFacetSpec.

getDynamicFacetSpecOrBuilder()

public SearchRequest.DynamicFacetSpecOrBuilder getDynamicFacetSpecOrBuilder()

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

.google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;

Returns
Type	Description
SearchRequest.DynamicFacetSpecOrBuilder

getEnableCategoryFilterLevel()

public String getEnableCategoryFilterLevel()

Whether to add additional category filters on the similar-items model. If not specified, we enable it by default. Allowed values are:

• no-category-match: No additional filtering of original results from the model and the customer's filters.

• relaxed-category-match: Only keep results with categories that match at least one item categories in the PredictRequests's context item.

  • If customer also sends filters in the PredictRequest, then the results will satisfy both conditions (user given and category match).

  Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.

string enable_category_filter_level = 16;

Returns
Type	Description
String	The enableCategoryFilterLevel.

getEnableCategoryFilterLevelBytes()

public ByteString getEnableCategoryFilterLevelBytes()

Whether to add additional category filters on the similar-items model. If not specified, we enable it by default. Allowed values are:

• no-category-match: No additional filtering of original results from the model and the customer's filters.

• relaxed-category-match: Only keep results with categories that match at least one item categories in the PredictRequests's context item.

  • If customer also sends filters in the PredictRequest, then the results will satisfy both conditions (user given and category match).

  Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.

string enable_category_filter_level = 16;

Returns
Type	Description
ByteString	The bytes for enableCategoryFilterLevel.

getFacetControlIds(int index)

public String getFacetControlIds(int index)

Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of Control resources with only the Facet control set. These controls are assumed to be in the same Catalog as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string facet_control_ids = 5;

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

Returns
Type	Description
String	The facetControlIds at the given index.

getFacetControlIdsBytes(int index)

public ByteString getFacetControlIdsBytes(int index)

Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of Control resources with only the Facet control set. These controls are assumed to be in the same Catalog as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string facet_control_ids = 5;

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

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

getFacetControlIdsCount()

public int getFacetControlIdsCount()

Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of Control resources with only the Facet control set. These controls are assumed to be in the same Catalog as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string facet_control_ids = 5;

Returns
Type	Description
int	The count of facetControlIds.

getFacetControlIdsList()

public ProtocolStringList getFacetControlIdsList()

Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of Control resources with only the Facet control set. These controls are assumed to be in the same Catalog as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string facet_control_ids = 5;

Returns
Type	Description
ProtocolStringList	A list containing the facetControlIds.

getFilterControlIds(int index)

public String getFilterControlIds(int index)

Condition filter specifications. If a product matches multiple conditions in the specifications, filters from these specifications are all applied and combined via the AND operator. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string filter_control_ids = 9;

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

Returns
Type	Description
String	The filterControlIds at the given index.

getFilterControlIdsBytes(int index)

public ByteString getFilterControlIdsBytes(int index)

Condition filter specifications. If a product matches multiple conditions in the specifications, filters from these specifications are all applied and combined via the AND operator. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string filter_control_ids = 9;

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

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

getFilterControlIdsCount()

public int getFilterControlIdsCount()

Condition filter specifications. If a product matches multiple conditions in the specifications, filters from these specifications are all applied and combined via the AND operator. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string filter_control_ids = 9;

Returns
Type	Description
int	The count of filterControlIds.

getFilterControlIdsList()

public ProtocolStringList getFilterControlIdsList()

Condition filter specifications. If a product matches multiple conditions in the specifications, filters from these specifications are all applied and combined via the AND operator. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string filter_control_ids = 9;

Returns
Type	Description
ProtocolStringList	A list containing the filterControlIds.

getIgnoreControlIds(int index)

public String getIgnoreControlIds(int index)

Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string ignore_control_ids = 15;

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

Returns
Type	Description
String	The ignoreControlIds at the given index.

getIgnoreControlIdsBytes(int index)

public ByteString getIgnoreControlIdsBytes(int index)

Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string ignore_control_ids = 15;

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

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

getIgnoreControlIdsCount()

public int getIgnoreControlIdsCount()

Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string ignore_control_ids = 15;

Returns
Type	Description
int	The count of ignoreControlIds.

getIgnoreControlIdsList()

public ProtocolStringList getIgnoreControlIdsList()

Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute.

• Order does not matter.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string ignore_control_ids = 15;

Returns
Type	Description
ProtocolStringList	A list containing the ignoreControlIds.

getModelId()

public String getModelId()

The id of the model in the same Catalog to use at serving time. Currently only RecommendationModels are supported: https://cloud.google.com/retail/recommendations-ai/docs/create-models Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR).

Required when solution_types is SOLUTION_TYPE_RECOMMENDATION.

string model_id = 3;

Returns
Type	Description
String	The modelId.

getModelIdBytes()

public ByteString getModelIdBytes()

The id of the model in the same Catalog to use at serving time. Currently only RecommendationModels are supported: https://cloud.google.com/retail/recommendations-ai/docs/create-models Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR).

Required when solution_types is SOLUTION_TYPE_RECOMMENDATION.

string model_id = 3;

Returns
Type	Description
ByteString	The bytes for modelId.

getName()

public String getName()

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

getOnewaySynonymsControlIds(int index)

public String getOnewaySynonymsControlIds(int index)

Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string oneway_synonyms_control_ids = 12;

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

Returns
Type	Description
String	The onewaySynonymsControlIds at the given index.

getOnewaySynonymsControlIdsBytes(int index)

public ByteString getOnewaySynonymsControlIdsBytes(int index)

Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string oneway_synonyms_control_ids = 12;

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

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

getOnewaySynonymsControlIdsCount()

public int getOnewaySynonymsControlIdsCount()

Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string oneway_synonyms_control_ids = 12;

Returns
Type	Description
int	The count of onewaySynonymsControlIds.

getOnewaySynonymsControlIdsList()

public ProtocolStringList getOnewaySynonymsControlIdsList()

Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string oneway_synonyms_control_ids = 12;

Returns
Type	Description
ProtocolStringList	A list containing the onewaySynonymsControlIds.

getParserForType()

public Parser<ServingConfig> getParserForType()

Returns
Type	Description
Parser<ServingConfig>

Overrides

GeneratedMessageV3.getParserForType()

getPersonalizationSpec()

public SearchRequest.PersonalizationSpec getPersonalizationSpec()

The specification for personalization spec.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.

.google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 21;

Returns
Type	Description
SearchRequest.PersonalizationSpec	The personalizationSpec.

getPersonalizationSpecOrBuilder()

public SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()

The specification for personalization spec.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.

.google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 21;

Returns
Type	Description
SearchRequest.PersonalizationSpecOrBuilder

getPriceRerankingLevel()

public String getPriceRerankingLevel()

How much price ranking we want in serving results. Price reranking causes product items with a similar recommendation probability to be ordered by price, with the highest-priced items first. This setting could result in a decrease in click-through and conversion rates. Allowed values are:

• no-price-reranking
• low-price-reranking
• medium-price-reranking

• high-price-reranking

  If not specified, we choose default based on model type. Default value: no-price-reranking.

  Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.

string price_reranking_level = 4;

Returns
Type	Description
String	The priceRerankingLevel.

getPriceRerankingLevelBytes()

public ByteString getPriceRerankingLevelBytes()

How much price ranking we want in serving results. Price reranking causes product items with a similar recommendation probability to be ordered by price, with the highest-priced items first. This setting could result in a decrease in click-through and conversion rates. Allowed values are:

• no-price-reranking
• low-price-reranking
• medium-price-reranking

• high-price-reranking

  If not specified, we choose default based on model type. Default value: no-price-reranking.

  Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.

string price_reranking_level = 4;

Returns
Type	Description
ByteString	The bytes for priceRerankingLevel.

getRedirectControlIds(int index)

public String getRedirectControlIds(int index)

Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string redirect_control_ids = 10;

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

Returns
Type	Description
String	The redirectControlIds at the given index.

getRedirectControlIdsBytes(int index)

public ByteString getRedirectControlIdsBytes(int index)

Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string redirect_control_ids = 10;

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

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

getRedirectControlIdsCount()

public int getRedirectControlIdsCount()

Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string redirect_control_ids = 10;

Returns
Type	Description
int	The count of redirectControlIds.

getRedirectControlIdsList()

public ProtocolStringList getRedirectControlIdsList()

Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string redirect_control_ids = 10;

Returns
Type	Description
ProtocolStringList	A list containing the redirectControlIds.

getReplacementControlIds(int index)

public String getReplacementControlIds(int index)

Condition replacement specifications.

• Applied according to the order in the list.
• A previously replaced term can not be re-replaced.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string replacement_control_ids = 14;

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

Returns
Type	Description
String	The replacementControlIds at the given index.

getReplacementControlIdsBytes(int index)

public ByteString getReplacementControlIdsBytes(int index)

Condition replacement specifications.

• Applied according to the order in the list.
• A previously replaced term can not be re-replaced.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string replacement_control_ids = 14;

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

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

getReplacementControlIdsCount()

public int getReplacementControlIdsCount()

Condition replacement specifications.

• Applied according to the order in the list.
• A previously replaced term can not be re-replaced.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string replacement_control_ids = 14;

Returns
Type	Description
int	The count of replacementControlIds.

getReplacementControlIdsList()

public ProtocolStringList getReplacementControlIdsList()

Condition replacement specifications.

• Applied according to the order in the list.
• A previously replaced term can not be re-replaced.

• Maximum number of specifications is 100.

  Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string replacement_control_ids = 14;

Returns
Type	Description
ProtocolStringList	A list containing the replacementControlIds.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSolutionTypes(int index)

public SolutionType getSolutionTypes(int index)

Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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

Returns
Type	Description
SolutionType	The solutionTypes at the given index.

getSolutionTypesCount()

public int getSolutionTypesCount()

Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
int	The count of solutionTypes.

getSolutionTypesList()

public List<SolutionType> getSolutionTypesList()

Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
List<SolutionType>	A list containing the solutionTypes.

getSolutionTypesValue(int index)

public int getSolutionTypesValue(int index)

Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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

Returns
Type	Description
int	The enum numeric value on the wire of solutionTypes at the given index.

getSolutionTypesValueList()

public List<Integer> getSolutionTypesValueList()

Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution.

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 19 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for solutionTypes.

getTwowaySynonymsControlIds(int index)

public String getTwowaySynonymsControlIds(int index)

Condition synonyms specifications. If multiple syonyms conditions match, all matching synonyms control in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string twoway_synonyms_control_ids = 18;

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

Returns
Type	Description
String	The twowaySynonymsControlIds at the given index.

getTwowaySynonymsControlIdsBytes(int index)

public ByteString getTwowaySynonymsControlIdsBytes(int index)

Condition synonyms specifications. If multiple syonyms conditions match, all matching synonyms control in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string twoway_synonyms_control_ids = 18;

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

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

getTwowaySynonymsControlIdsCount()

public int getTwowaySynonymsControlIdsCount()

Condition synonyms specifications. If multiple syonyms conditions match, all matching synonyms control in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string twoway_synonyms_control_ids = 18;

Returns
Type	Description
int	The count of twowaySynonymsControlIds.

getTwowaySynonymsControlIdsList()

public ProtocolStringList getTwowaySynonymsControlIdsList()

Condition synonyms specifications. If multiple syonyms conditions match, all matching synonyms control in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

repeated string twoway_synonyms_control_ids = 18;

Returns
Type	Description
ProtocolStringList	A list containing the twowaySynonymsControlIds.

hasDynamicFacetSpec()

public boolean hasDynamicFacetSpec()

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

.google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 6;

Returns
Type	Description
boolean	Whether the dynamicFacetSpec field is set.

hasPersonalizationSpec()

public boolean hasPersonalizationSpec()

The specification for personalization spec.

Can only be set if solution_types is SOLUTION_TYPE_SEARCH.

Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.

.google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 21;

Returns
Type	Description
boolean	Whether the personalizationSpec field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ServingConfig.Builder newBuilderForType()

Returns
Type	Description
ServingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ServingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ServingConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ServingConfig.Builder toBuilder()

Returns
Type	Description
ServingConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException