ServingConfig (proto-google-cloud-retail-v2alpha 2.35.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.retail.v2alpha.ServingConfig

All Implemented Interfaces:

ServingConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class ServingConfig
extends com.google.protobuf.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
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ServingConfig.Builder` Configures metadata that is used to generate serving time results (e.g.
`static class`	`ServingConfig.DiversityType` What type of diversity - data or rule based.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOOST_CONTROL_IDS_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`DIVERSITY_LEVEL_FIELD_NUMBER`
`static int`	`DIVERSITY_TYPE_FIELD_NUMBER`
`static int`	`DO_NOT_ASSOCIATE_CONTROL_IDS_FIELD_NUMBER`
`static int`	`DYNAMIC_FACET_SPEC_FIELD_NUMBER`
`static int`	`ENABLE_CATEGORY_FILTER_LEVEL_FIELD_NUMBER`
`static int`	`FACET_CONTROL_IDS_FIELD_NUMBER`
`static int`	`FILTER_CONTROL_IDS_FIELD_NUMBER`
`static int`	`IGNORE_CONTROL_IDS_FIELD_NUMBER`
`static int`	`MODEL_ID_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER`
`static int`	`PERSONALIZATION_SPEC_FIELD_NUMBER`
`static int`	`PRICE_RERANKING_LEVEL_FIELD_NUMBER`
`static int`	`REDIRECT_CONTROL_IDS_FIELD_NUMBER`
`static int`	`REPLACEMENT_CONTROL_IDS_FIELD_NUMBER`
`static int`	`SOLUTION_TYPES_FIELD_NUMBER`
`static int`	`TWOWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getBoostControlIds(int index)` Condition boost specifications.
`com.google.protobuf.ByteString`	`getBoostControlIdsBytes(int index)` Condition boost specifications.
`int`	`getBoostControlIdsCount()` Condition boost specifications.
`com.google.protobuf.ProtocolStringList`	`getBoostControlIdsList()` Condition boost specifications.
`static ServingConfig`	`getDefaultInstance()`
`ServingConfig`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` Required.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Required.
`String`	`getDiversityLevel()` How much diversity to use in recommendation model results e.g.
`com.google.protobuf.ByteString`	`getDiversityLevelBytes()` How much diversity to use in recommendation model results e.g.
`ServingConfig.DiversityType`	`getDiversityType()` What kind of diversity to use - data driven or rule based.
`int`	`getDiversityTypeValue()` What kind of diversity to use - data driven or rule based.
`String`	`getDoNotAssociateControlIds(int index)` Condition do not associate specifications.
`com.google.protobuf.ByteString`	`getDoNotAssociateControlIdsBytes(int index)` Condition do not associate specifications.
`int`	`getDoNotAssociateControlIdsCount()` Condition do not associate specifications.
`com.google.protobuf.ProtocolStringList`	`getDoNotAssociateControlIdsList()` Condition do not associate specifications.
`SearchRequest.DynamicFacetSpec`	`getDynamicFacetSpec()` The specification for dynamically generated facets.
`SearchRequest.DynamicFacetSpecOrBuilder`	`getDynamicFacetSpecOrBuilder()` The specification for dynamically generated facets.
`String`	`getEnableCategoryFilterLevel()` Whether to add additional category filters on the `similar-items` model.
`com.google.protobuf.ByteString`	`getEnableCategoryFilterLevelBytes()` Whether to add additional category filters on the `similar-items` model.
`String`	`getFacetControlIds(int index)` Facet specifications for faceted search.
`com.google.protobuf.ByteString`	`getFacetControlIdsBytes(int index)` Facet specifications for faceted search.
`int`	`getFacetControlIdsCount()` Facet specifications for faceted search.
`com.google.protobuf.ProtocolStringList`	`getFacetControlIdsList()` Facet specifications for faceted search.
`String`	`getFilterControlIds(int index)` Condition filter specifications.
`com.google.protobuf.ByteString`	`getFilterControlIdsBytes(int index)` Condition filter specifications.
`int`	`getFilterControlIdsCount()` Condition filter specifications.
`com.google.protobuf.ProtocolStringList`	`getFilterControlIdsList()` Condition filter specifications.
`String`	`getIgnoreControlIds(int index)` Condition ignore specifications.
`com.google.protobuf.ByteString`	`getIgnoreControlIdsBytes(int index)` Condition ignore specifications.
`int`	`getIgnoreControlIdsCount()` Condition ignore specifications.
`com.google.protobuf.ProtocolStringList`	`getIgnoreControlIdsList()` Condition ignore specifications.
`String`	`getModelId()` The id of the model in the same [Catalog][google.cloud.retail.v2alpha.Catalog] to use at serving time.
`com.google.protobuf.ByteString`	`getModelIdBytes()` The id of the model in the same [Catalog][google.cloud.retail.v2alpha.Catalog] to use at serving time.
`String`	`getName()` Immutable.
`com.google.protobuf.ByteString`	`getNameBytes()` Immutable.
`String`	`getOnewaySynonymsControlIds(int index)` Condition oneway synonyms specifications.
`com.google.protobuf.ByteString`	`getOnewaySynonymsControlIdsBytes(int index)` Condition oneway synonyms specifications.
`int`	`getOnewaySynonymsControlIdsCount()` Condition oneway synonyms specifications.
`com.google.protobuf.ProtocolStringList`	`getOnewaySynonymsControlIdsList()` Condition oneway synonyms specifications.
`com.google.protobuf.Parser<ServingConfig>`	`getParserForType()`
`SearchRequest.PersonalizationSpec`	`getPersonalizationSpec()` The specification for personalization spec.
`SearchRequest.PersonalizationSpecOrBuilder`	`getPersonalizationSpecOrBuilder()` The specification for personalization spec.
`String`	`getPriceRerankingLevel()` How much price ranking we want in serving results.
`com.google.protobuf.ByteString`	`getPriceRerankingLevelBytes()` How much price ranking we want in serving results.
`String`	`getRedirectControlIds(int index)` Condition redirect specifications.
`com.google.protobuf.ByteString`	`getRedirectControlIdsBytes(int index)` Condition redirect specifications.
`int`	`getRedirectControlIdsCount()` Condition redirect specifications.
`com.google.protobuf.ProtocolStringList`	`getRedirectControlIdsList()` Condition redirect specifications.
`String`	`getReplacementControlIds(int index)` Condition replacement specifications.
`com.google.protobuf.ByteString`	`getReplacementControlIdsBytes(int index)` Condition replacement specifications.
`int`	`getReplacementControlIdsCount()` Condition replacement specifications.
`com.google.protobuf.ProtocolStringList`	`getReplacementControlIdsList()` Condition replacement specifications.
`int`	`getSerializedSize()`
`SolutionType`	`getSolutionTypes(int index)` Required.
`int`	`getSolutionTypesCount()` Required.
`List<SolutionType>`	`getSolutionTypesList()` Required.
`int`	`getSolutionTypesValue(int index)` Required.
`List<Integer>`	`getSolutionTypesValueList()` Required.
`String`	`getTwowaySynonymsControlIds(int index)` Condition synonyms specifications.
`com.google.protobuf.ByteString`	`getTwowaySynonymsControlIdsBytes(int index)` Condition synonyms specifications.
`int`	`getTwowaySynonymsControlIdsCount()` Condition synonyms specifications.
`com.google.protobuf.ProtocolStringList`	`getTwowaySynonymsControlIdsList()` Condition synonyms specifications.
`boolean`	`hasDynamicFacetSpec()` The specification for dynamically generated facets.
`int`	`hashCode()`
`boolean`	`hasPersonalizationSpec()` The specification for personalization spec.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static ServingConfig.Builder`	`newBuilder()`
`static ServingConfig.Builder`	`newBuilder(ServingConfig prototype)`
`ServingConfig.Builder`	`newBuilderForType()`
`protected ServingConfig.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static ServingConfig`	`parseDelimitedFrom(InputStream input)`
`static ServingConfig`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ServingConfig`	`parseFrom(byte[] data)`
`static ServingConfig`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ServingConfig`	`parseFrom(ByteBuffer data)`
`static ServingConfig`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ServingConfig`	`parseFrom(com.google.protobuf.ByteString data)`
`static ServingConfig`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ServingConfig`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static ServingConfig`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ServingConfig`	`parseFrom(InputStream input)`
`static ServingConfig`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<ServingConfig>`	`parser()`
`ServingConfig.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MODEL_ID_FIELD_NUMBER
```
public static final int MODEL_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PRICE_RERANKING_LEVEL_FIELD_NUMBER
```
public static final int PRICE_RERANKING_LEVEL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FACET_CONTROL_IDS_FIELD_NUMBER
```
public static final int FACET_CONTROL_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DYNAMIC_FACET_SPEC_FIELD_NUMBER
```
public static final int DYNAMIC_FACET_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BOOST_CONTROL_IDS_FIELD_NUMBER
```
public static final int BOOST_CONTROL_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FILTER_CONTROL_IDS_FIELD_NUMBER
```
public static final int FILTER_CONTROL_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REDIRECT_CONTROL_IDS_FIELD_NUMBER
```
public static final int REDIRECT_CONTROL_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TWOWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER
```
public static final int TWOWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER
```
public static final int ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DO_NOT_ASSOCIATE_CONTROL_IDS_FIELD_NUMBER
```
public static final int DO_NOT_ASSOCIATE_CONTROL_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REPLACEMENT_CONTROL_IDS_FIELD_NUMBER
```
public static final int REPLACEMENT_CONTROL_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IGNORE_CONTROL_IDS_FIELD_NUMBER
```
public static final int IGNORE_CONTROL_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DIVERSITY_LEVEL_FIELD_NUMBER
```
public static final int DIVERSITY_LEVEL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DIVERSITY_TYPE_FIELD_NUMBER
```
public static final int DIVERSITY_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENABLE_CATEGORY_FILTER_LEVEL_FIELD_NUMBER
```
public static final int ENABLE_CATEGORY_FILTER_LEVEL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PERSONALIZATION_SPEC_FIELD_NUMBER
```
public static final int PERSONALIZATION_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SOLUTION_TYPES_FIELD_NUMBER
```
public static final int SOLUTION_TYPES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName
```
public String getName()
```
```
 Immutable. Fully qualified name
 `projects/*/locations/global/catalogs/*/servingConfig/*`
 
```
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Specified by:

getName in interface ServingConfigOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Immutable. Fully qualified name
 `projects/*/locations/global/catalogs/*/servingConfig/*`
 
```
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Specified by:

getNameBytes in interface ServingConfigOrBuilder

Returns:

The bytes for name.

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];

Specified by:: getDisplayName in interface ServingConfigOrBuilder
Returns:: The displayName.

getDisplayNameBytes

public com.google.protobuf.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];

Specified by:: getDisplayNameBytes in interface ServingConfigOrBuilder
Returns:: The bytes for displayName.

getModelId

public String getModelId()

 The id of the model in the same
 [Catalog][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

string model_id = 3;

Specified by:: getModelId in interface ServingConfigOrBuilder
Returns:: The modelId.

getModelIdBytes

public com.google.protobuf.ByteString getModelIdBytes()

 The id of the model in the same
 [Catalog][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

string model_id = 3;

Specified by:: getModelIdBytes in interface ServingConfigOrBuilder
Returns:: The bytes for modelId.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

string price_reranking_level = 4;

Specified by:: getPriceRerankingLevel in interface ServingConfigOrBuilder
Returns:: The priceRerankingLevel.

getPriceRerankingLevelBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

string price_reranking_level = 4;

Specified by:: getPriceRerankingLevelBytes in interface ServingConfigOrBuilder
Returns:: The bytes for priceRerankingLevel.

getFacetControlIdsList

public com.google.protobuf.ProtocolStringList getFacetControlIdsList()

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

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string facet_control_ids = 5;

Specified by:: getFacetControlIdsList in interface ServingConfigOrBuilder
Returns:: A list containing the facetControlIds.

getFacetControlIdsCount

public int getFacetControlIdsCount()

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

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string facet_control_ids = 5;

Specified by:: getFacetControlIdsCount in interface ServingConfigOrBuilder
Returns:: The count of facetControlIds.

getFacetControlIds

public String getFacetControlIds(int index)

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

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string facet_control_ids = 5;

Specified by:: getFacetControlIds in interface ServingConfigOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The facetControlIds at the given index.

getFacetControlIdsBytes

public com.google.protobuf.ByteString getFacetControlIdsBytes(int index)

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

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string facet_control_ids = 5;

Specified by:: getFacetControlIdsBytes in interface ServingConfigOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the facetControlIds at the given index.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

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

Specified by:: hasDynamicFacetSpec in interface ServingConfigOrBuilder
Returns:: Whether the dynamicFacetSpec field is set.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

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

Specified by:: getDynamicFacetSpec in interface ServingConfigOrBuilder
Returns:: 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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

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

Specified by:: getDynamicFacetSpecOrBuilder in interface ServingConfigOrBuilder

getBoostControlIdsList

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string boost_control_ids = 7;

Specified by:: getBoostControlIdsList in interface ServingConfigOrBuilder
Returns:: A list containing the boostControlIds.

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][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string boost_control_ids = 7;

Specified by:: getBoostControlIdsCount in interface ServingConfigOrBuilder
Returns:: The count of boostControlIds.

getBoostControlIds

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][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string boost_control_ids = 7;

Specified by:: getBoostControlIds in interface ServingConfigOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The boostControlIds at the given index.

getBoostControlIdsBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string boost_control_ids = 7;

Specified by:: getBoostControlIdsBytes in interface ServingConfigOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the boostControlIds at the given index.

getFilterControlIdsList

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string filter_control_ids = 9;

Specified by:: getFilterControlIdsList in interface ServingConfigOrBuilder
Returns:: A list containing the filterControlIds.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string filter_control_ids = 9;

Specified by:: getFilterControlIdsCount in interface ServingConfigOrBuilder
Returns:: The count of filterControlIds.

getFilterControlIds

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string filter_control_ids = 9;

Specified by:: getFilterControlIds in interface ServingConfigOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The filterControlIds at the given index.

getFilterControlIdsBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string filter_control_ids = 9;

Specified by:: getFilterControlIdsBytes in interface ServingConfigOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the filterControlIds at the given index.

getRedirectControlIdsList

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string redirect_control_ids = 10;

Specified by:: getRedirectControlIdsList in interface ServingConfigOrBuilder
Returns:: A list containing the redirectControlIds.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string redirect_control_ids = 10;

Specified by:: getRedirectControlIdsCount in interface ServingConfigOrBuilder
Returns:: The count of redirectControlIds.

getRedirectControlIds

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string redirect_control_ids = 10;

Specified by:: getRedirectControlIds in interface ServingConfigOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The redirectControlIds at the given index.

getRedirectControlIdsBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string redirect_control_ids = 10;

Specified by:: getRedirectControlIdsBytes in interface ServingConfigOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the redirectControlIds at the given index.

getTwowaySynonymsControlIdsList

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string twoway_synonyms_control_ids = 18;

Specified by:: getTwowaySynonymsControlIdsList in interface ServingConfigOrBuilder
Returns:: A list containing the twowaySynonymsControlIds.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string twoway_synonyms_control_ids = 18;

Specified by:: getTwowaySynonymsControlIdsCount in interface ServingConfigOrBuilder
Returns:: The count of twowaySynonymsControlIds.

getTwowaySynonymsControlIds

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string twoway_synonyms_control_ids = 18;

Specified by:: getTwowaySynonymsControlIds in interface ServingConfigOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The twowaySynonymsControlIds at the given index.

getTwowaySynonymsControlIdsBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string twoway_synonyms_control_ids = 18;

Specified by:: getTwowaySynonymsControlIdsBytes in interface ServingConfigOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the twowaySynonymsControlIds at the given index.

getOnewaySynonymsControlIdsList

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string oneway_synonyms_control_ids = 12;

Specified by:: getOnewaySynonymsControlIdsList in interface ServingConfigOrBuilder
Returns:: A list containing the onewaySynonymsControlIds.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string oneway_synonyms_control_ids = 12;

Specified by:: getOnewaySynonymsControlIdsCount in interface ServingConfigOrBuilder
Returns:: The count of onewaySynonymsControlIds.

getOnewaySynonymsControlIds

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string oneway_synonyms_control_ids = 12;

Specified by:: getOnewaySynonymsControlIds in interface ServingConfigOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The onewaySynonymsControlIds at the given index.

getOnewaySynonymsControlIdsBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string oneway_synonyms_control_ids = 12;

Specified by:: getOnewaySynonymsControlIdsBytes in interface ServingConfigOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the onewaySynonymsControlIds at the given index.

getDoNotAssociateControlIdsList

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string do_not_associate_control_ids = 13;

Specified by:: getDoNotAssociateControlIdsList in interface ServingConfigOrBuilder
Returns:: A list containing the doNotAssociateControlIds.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string do_not_associate_control_ids = 13;

Specified by:: getDoNotAssociateControlIdsCount in interface ServingConfigOrBuilder
Returns:: The count of doNotAssociateControlIds.

getDoNotAssociateControlIds

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string do_not_associate_control_ids = 13;

Specified by:: getDoNotAssociateControlIds in interface ServingConfigOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The doNotAssociateControlIds at the given index.

getDoNotAssociateControlIdsBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string do_not_associate_control_ids = 13;

Specified by:: getDoNotAssociateControlIdsBytes in interface ServingConfigOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the doNotAssociateControlIds at the given index.

getReplacementControlIdsList

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string replacement_control_ids = 14;

Specified by:: getReplacementControlIdsList in interface ServingConfigOrBuilder
Returns:: A list containing the replacementControlIds.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string replacement_control_ids = 14;

Specified by:: getReplacementControlIdsCount in interface ServingConfigOrBuilder
Returns:: The count of replacementControlIds.

getReplacementControlIds

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string replacement_control_ids = 14;

Specified by:: getReplacementControlIds in interface ServingConfigOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The replacementControlIds at the given index.

getReplacementControlIdsBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string replacement_control_ids = 14;

Specified by:: getReplacementControlIdsBytes in interface ServingConfigOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the replacementControlIds at the given index.

getIgnoreControlIdsList

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string ignore_control_ids = 15;

Specified by:: getIgnoreControlIdsList in interface ServingConfigOrBuilder
Returns:: A list containing the ignoreControlIds.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string ignore_control_ids = 15;

Specified by:: getIgnoreControlIdsCount in interface ServingConfigOrBuilder
Returns:: The count of ignoreControlIds.

getIgnoreControlIds

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string ignore_control_ids = 15;

Specified by:: getIgnoreControlIds in interface ServingConfigOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The ignoreControlIds at the given index.

getIgnoreControlIdsBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

repeated string ignore_control_ids = 15;

Specified by:: getIgnoreControlIdsBytes in interface ServingConfigOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the ignoreControlIds at the given index.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

string diversity_level = 8;

Specified by:: getDiversityLevel in interface ServingConfigOrBuilder
Returns:: The diversityLevel.

getDiversityLevelBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

string diversity_level = 8;

Specified by:: getDiversityLevelBytes in interface ServingConfigOrBuilder
Returns:: The bytes for diversityLevel.

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.RULE_BASED_DIVERSITY].

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

Specified by:: getDiversityTypeValue in interface ServingConfigOrBuilder
Returns:: The enum numeric value on the wire for diversityType.

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.RULE_BASED_DIVERSITY].

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

Specified by:: getDiversityType in interface ServingConfigOrBuilder
Returns:: The diversityType.

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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

string enable_category_filter_level = 16;

Specified by:: getEnableCategoryFilterLevel in interface ServingConfigOrBuilder
Returns:: The enableCategoryFilterLevel.

getEnableCategoryFilterLevelBytes

public com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

string enable_category_filter_level = 16;

Specified by:: getEnableCategoryFilterLevelBytes in interface ServingConfigOrBuilder
Returns:: The bytes for enableCategoryFilterLevel.

hasPersonalizationSpec

public boolean hasPersonalizationSpec()

 The specification for personalization spec.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 are set.
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 will override
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec].

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

Specified by:: hasPersonalizationSpec in interface ServingConfigOrBuilder
Returns:: Whether the personalizationSpec field is set.

getPersonalizationSpec

public SearchRequest.PersonalizationSpec getPersonalizationSpec()

 The specification for personalization spec.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 are set.
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 will override
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec].

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

Specified by:: getPersonalizationSpec in interface ServingConfigOrBuilder
Returns:: The personalizationSpec.

getPersonalizationSpecOrBuilder

public SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()

 The specification for personalization spec.

 Can only be set if
 [solution_types][google.cloud.retail.v2alpha.ServingConfig.solution_types]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 are set.
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 will override
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec].

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

Specified by:: getPersonalizationSpecOrBuilder in interface ServingConfigOrBuilder

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];
Specified by:

getSolutionTypesList in interface ServingConfigOrBuilder

Returns:

A list containing the solutionTypes.

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];
Specified by:

getSolutionTypesCount in interface ServingConfigOrBuilder

Returns:

The count of solutionTypes.

getSolutionTypes
```
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];
Specified by:

getSolutionTypes in interface ServingConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The 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];
Specified by:

getSolutionTypesValueList in interface ServingConfigOrBuilder

Returns:

A list containing the enum numeric values on the wire for solutionTypes.

getSolutionTypesValue
```
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];
Specified by:

getSolutionTypesValue in interface ServingConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of solutionTypes at the given index.

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo
```
public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
```
Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize
```
public int getSerializedSize()
```
Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals
```
public boolean equals(Object obj)
```
Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode
```
public int hashCode()
```
Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ServingConfig parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServingConfig parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServingConfig parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServingConfig parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServingConfig parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServingConfig parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServingConfig parseFrom(InputStream input)
                               throws IOException

Throws:: IOException

parseFrom

public static ServingConfig parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:: IOException

parseDelimitedFrom

public static ServingConfig parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:: IOException

parseDelimitedFrom

public static ServingConfig parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:: IOException

parseFrom

public static ServingConfig parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:: IOException

parseFrom

public static ServingConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:: IOException

newBuilderForType
```
public ServingConfig.Builder newBuilderForType()
```
Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ServingConfig.Builder newBuilder()

newBuilder

public static ServingConfig.Builder newBuilder(ServingConfig prototype)

toBuilder
```
public ServingConfig.Builder toBuilder()
```
Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ServingConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:: newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ServingConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<ServingConfig> parser()

getParserForType
```
public com.google.protobuf.Parser<ServingConfig> getParserForType()
```
Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType
```
public ServingConfig getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class ServingConfig

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

NAME_FIELD_NUMBER

DISPLAY_NAME_FIELD_NUMBER

MODEL_ID_FIELD_NUMBER

PRICE_RERANKING_LEVEL_FIELD_NUMBER

FACET_CONTROL_IDS_FIELD_NUMBER

DYNAMIC_FACET_SPEC_FIELD_NUMBER

BOOST_CONTROL_IDS_FIELD_NUMBER

FILTER_CONTROL_IDS_FIELD_NUMBER

REDIRECT_CONTROL_IDS_FIELD_NUMBER

TWOWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER

ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER

DO_NOT_ASSOCIATE_CONTROL_IDS_FIELD_NUMBER

REPLACEMENT_CONTROL_IDS_FIELD_NUMBER

IGNORE_CONTROL_IDS_FIELD_NUMBER

DIVERSITY_LEVEL_FIELD_NUMBER

DIVERSITY_TYPE_FIELD_NUMBER

ENABLE_CATEGORY_FILTER_LEVEL_FIELD_NUMBER

PERSONALIZATION_SPEC_FIELD_NUMBER

SOLUTION_TYPES_FIELD_NUMBER

Method Detail

newInstance

getDescriptor

internalGetFieldAccessorTable

getName

getNameBytes

getDisplayName

getDisplayNameBytes

getModelId

getModelIdBytes

getPriceRerankingLevel

getPriceRerankingLevelBytes

getFacetControlIdsList

getFacetControlIdsCount

getFacetControlIds

getFacetControlIdsBytes

hasDynamicFacetSpec

getDynamicFacetSpec

getDynamicFacetSpecOrBuilder

getBoostControlIdsList

getBoostControlIdsCount

getBoostControlIds

getBoostControlIdsBytes

getFilterControlIdsList

getFilterControlIdsCount

getFilterControlIds

getFilterControlIdsBytes

getRedirectControlIdsList

getRedirectControlIdsCount

getRedirectControlIds

getRedirectControlIdsBytes

getTwowaySynonymsControlIdsList

getTwowaySynonymsControlIdsCount

getTwowaySynonymsControlIds

getTwowaySynonymsControlIdsBytes

getOnewaySynonymsControlIdsList

getOnewaySynonymsControlIdsCount

getOnewaySynonymsControlIds

getOnewaySynonymsControlIdsBytes

getDoNotAssociateControlIdsList

getDoNotAssociateControlIdsCount

getDoNotAssociateControlIds

getDoNotAssociateControlIdsBytes

getReplacementControlIdsList

getReplacementControlIdsCount