com.google.cloud.discoveryengine.v1beta

Interface ServingConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ServingConfig, ServingConfig.Builder

public interface ServingConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getBoostControlIds(int index) Boost controls to use in serving path.
com.google.protobuf.ByteString	getBoostControlIdsBytes(int index) Boost controls to use in serving path.
int	getBoostControlIdsCount() Boost controls to use in serving path.
List<String>	getBoostControlIdsList() Boost controls to use in serving path.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
String	getDissociateControlIds(int index) Condition do not associate specifications.
com.google.protobuf.ByteString	getDissociateControlIdsBytes(int index) Condition do not associate specifications.
int	getDissociateControlIdsCount() Condition do not associate specifications.
List<String>	getDissociateControlIdsList() Condition do not associate specifications.
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.
EmbeddingConfig	getEmbeddingConfig() Bring your own embedding config.
EmbeddingConfigOrBuilder	getEmbeddingConfigOrBuilder() Bring your own embedding config.
String	getFilterControlIds(int index) Filter controls to use in serving path.
com.google.protobuf.ByteString	getFilterControlIdsBytes(int index) Filter controls to use in serving path.
int	getFilterControlIdsCount() Filter controls to use in serving path.
List<String>	getFilterControlIdsList() Filter controls to use in serving path.
ServingConfig.GenericConfig	getGenericConfig() The GenericConfig of the serving configuration.
ServingConfig.GenericConfigOrBuilder	getGenericConfigOrBuilder() The GenericConfig of the serving configuration.
String	getIgnoreControlIds(int index) Condition ignore specifications.
com.google.protobuf.ByteString	getIgnoreControlIdsBytes(int index) Condition ignore specifications.
int	getIgnoreControlIdsCount() Condition ignore specifications.
List<String>	getIgnoreControlIdsList() Condition ignore specifications.
ServingConfig.MediaConfig	getMediaConfig() The MediaConfig of the serving configuration.
ServingConfig.MediaConfigOrBuilder	getMediaConfigOrBuilder() The MediaConfig of the serving configuration.
String	getModelId() The id of the model to use at serving time.
com.google.protobuf.ByteString	getModelIdBytes() The id of the model 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.
List<String>	getOnewaySynonymsControlIdsList() Condition oneway synonyms specifications.
SearchRequest.PersonalizationSpec	getPersonalizationSpec() The specification for personalization spec.
SearchRequest.PersonalizationSpecOrBuilder	getPersonalizationSpecOrBuilder() The specification for personalization spec.
String	getRankingExpression() The ranking expression controls the customized ranking on retrieval documents.
com.google.protobuf.ByteString	getRankingExpressionBytes() The ranking expression controls the customized ranking on retrieval documents.
String	getRedirectControlIds(int index) IDs of the redirect controls.
com.google.protobuf.ByteString	getRedirectControlIdsBytes(int index) IDs of the redirect controls.
int	getRedirectControlIdsCount() IDs of the redirect controls.
List<String>	getRedirectControlIdsList() IDs of the redirect controls.
String	getReplacementControlIds(int index) Condition replacement specifications.
com.google.protobuf.ByteString	getReplacementControlIdsBytes(int index) Condition replacement specifications.
int	getReplacementControlIdsCount() Condition replacement specifications.
List<String>	getReplacementControlIdsList() Condition replacement specifications.
SolutionType	getSolutionType() Required.
int	getSolutionTypeValue() Required.
String	getSynonymsControlIds(int index) Condition synonyms specifications.
com.google.protobuf.ByteString	getSynonymsControlIdsBytes(int index) Condition synonyms specifications.
int	getSynonymsControlIdsCount() Condition synonyms specifications.
List<String>	getSynonymsControlIdsList() Condition synonyms specifications.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
ServingConfig.VerticalConfigCase	getVerticalConfigCase()
boolean	hasCreateTime() Output only.
boolean	hasEmbeddingConfig() Bring your own embedding config.
boolean	hasGenericConfig() The GenericConfig of the serving configuration.
boolean	hasMediaConfig() The MediaConfig of the serving configuration.
boolean	hasPersonalizationSpec() The specification for personalization spec.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasMediaConfig

boolean hasMediaConfig()

 The MediaConfig of the serving configuration.
 

.google.cloud.discoveryengine.v1beta.ServingConfig.MediaConfig media_config = 7;

Returns:

Whether the mediaConfig field is set.

getMediaConfig

ServingConfig.MediaConfig getMediaConfig()

 The MediaConfig of the serving configuration.
 

.google.cloud.discoveryengine.v1beta.ServingConfig.MediaConfig media_config = 7;

Returns:

The mediaConfig.

getMediaConfigOrBuilder

ServingConfig.MediaConfigOrBuilder getMediaConfigOrBuilder()

 The MediaConfig of the serving configuration.
 

.google.cloud.discoveryengine.v1beta.ServingConfig.MediaConfig media_config = 7;

hasGenericConfig

boolean hasGenericConfig()

 The GenericConfig of the serving configuration.
 

.google.cloud.discoveryengine.v1beta.ServingConfig.GenericConfig generic_config = 10;

Returns:

Whether the genericConfig field is set.

getGenericConfig

ServingConfig.GenericConfig getGenericConfig()

 The GenericConfig of the serving configuration.
 

.google.cloud.discoveryengine.v1beta.ServingConfig.GenericConfig generic_config = 10;

Returns:

The genericConfig.

getGenericConfigOrBuilder

ServingConfig.GenericConfigOrBuilder getGenericConfigOrBuilder()

 The GenericConfig of the serving configuration.
 

.google.cloud.discoveryengine.v1beta.ServingConfig.GenericConfig generic_config = 10;

getName

String getName()

 Immutable. Fully qualified name
 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Immutable. Fully qualified name
 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
 

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

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

 Required. The human readable serving config display name. Used in Discovery
 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:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Required. The human readable serving config display name. Used in Discovery
 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:

The bytes for displayName.

getSolutionTypeValue

int getSolutionTypeValue()

 Required. Immutable. Specifies the solution type that a serving config can
 be associated with.
 

.google.cloud.discoveryengine.v1beta.SolutionType solution_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns:

The enum numeric value on the wire for solutionType.

getSolutionType

SolutionType getSolutionType()

 Required. Immutable. Specifies the solution type that a serving config can
 be associated with.
 

.google.cloud.discoveryengine.v1beta.SolutionType solution_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns:

The solutionType.

getModelId

String getModelId()

 The id of the model to use at serving time.
 Currently only RecommendationModels are supported.
 Can be changed but only to a compatible model (e.g.
 others-you-may-like CTR to others-you-may-like CVR).

 Required when
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
 

string model_id = 4;

Returns:

The modelId.

getModelIdBytes

com.google.protobuf.ByteString getModelIdBytes()

 The id of the model to use at serving time.
 Currently only RecommendationModels are supported.
 Can be changed but only to a compatible model (e.g.
 others-you-may-like CTR to others-you-may-like CVR).

 Required when
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
 

string model_id = 4;

Returns:

The bytes for modelId.

getDiversityLevel

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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
 

string diversity_level = 5;

Returns:

The diversityLevel.

getDiversityLevelBytes

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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
 

string diversity_level = 5;

Returns:

The bytes for diversityLevel.

hasEmbeddingConfig

boolean hasEmbeddingConfig()

 Bring your own embedding config. The config is used for search semantic
 retrieval. The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embeddings that are provided by this EmbeddingConfig. If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 is provided, it overrides this
 [ServingConfig.embedding_config][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
 

.google.cloud.discoveryengine.v1beta.EmbeddingConfig embedding_config = 20;

Returns:

Whether the embeddingConfig field is set.

getEmbeddingConfig

EmbeddingConfig getEmbeddingConfig()

 Bring your own embedding config. The config is used for search semantic
 retrieval. The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embeddings that are provided by this EmbeddingConfig. If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 is provided, it overrides this
 [ServingConfig.embedding_config][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
 

.google.cloud.discoveryengine.v1beta.EmbeddingConfig embedding_config = 20;

Returns:

The embeddingConfig.

getEmbeddingConfigOrBuilder

EmbeddingConfigOrBuilder getEmbeddingConfigOrBuilder()

 Bring your own embedding config. The config is used for search semantic
 retrieval. The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embeddings that are provided by this EmbeddingConfig. If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 is provided, it overrides this
 [ServingConfig.embedding_config][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
 

.google.cloud.discoveryengine.v1beta.EmbeddingConfig embedding_config = 20;

getRankingExpression

String getRankingExpression()

 The ranking expression controls the customized ranking on retrieval
 documents. To leverage this, document embedding is required. The ranking
 expression setting in ServingConfig applies to all search requests served
 by the serving config. However, if
 [SearchRequest.ranking_expression][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression]
 is specified, it overrides the ServingConfig ranking expression.

 The ranking expression is a single function or multiple functions that are
 joined by "+".

   * ranking_expression = function, { " + ", function };

 Supported functions:

   * double * relevance_score
   * double * dotProduct(embedding_field_path)

 Function variables:

   * `relevance_score`: pre-defined keywords, used for measure relevance
   between query and document.
   * `embedding_field_path`: the document embedding field
   used with query embedding vector.
   * `dotProduct`: embedding function between embedding_field_path and query
   embedding vector.

  Example ranking expression:

    If document has an embedding field doc_embedding, the ranking expression
    could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
 

string ranking_expression = 21;

Returns:

The rankingExpression.

getRankingExpressionBytes

com.google.protobuf.ByteString getRankingExpressionBytes()

 The ranking expression controls the customized ranking on retrieval
 documents. To leverage this, document embedding is required. The ranking
 expression setting in ServingConfig applies to all search requests served
 by the serving config. However, if
 [SearchRequest.ranking_expression][google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression]
 is specified, it overrides the ServingConfig ranking expression.

 The ranking expression is a single function or multiple functions that are
 joined by "+".

   * ranking_expression = function, { " + ", function };

 Supported functions:

   * double * relevance_score
   * double * dotProduct(embedding_field_path)

 Function variables:

   * `relevance_score`: pre-defined keywords, used for measure relevance
   between query and document.
   * `embedding_field_path`: the document embedding field
   used with query embedding vector.
   * `dotProduct`: embedding function between embedding_field_path and query
   embedding vector.

  Example ranking expression:

    If document has an embedding field doc_embedding, the ranking expression
    could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
 

string ranking_expression = 21;

Returns:

The bytes for rankingExpression.

hasCreateTime

boolean hasCreateTime()

 Output only. ServingConfig created timestamp.
 

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. ServingConfig created timestamp.
 

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. ServingConfig created timestamp.
 

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

 Output only. ServingConfig updated timestamp.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. ServingConfig updated timestamp.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. ServingConfig updated timestamp.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getFilterControlIdsList

List<String> getFilterControlIdsList()

 Filter controls to use in serving path.
 All triggered filter controls will be applied.
 Filter controls must be in the same data store as the serving config.
 Maximum of 20 filter controls.
 

repeated string filter_control_ids = 11;

Returns:

A list containing the filterControlIds.

getFilterControlIdsCount

int getFilterControlIdsCount()

 Filter controls to use in serving path.
 All triggered filter controls will be applied.
 Filter controls must be in the same data store as the serving config.
 Maximum of 20 filter controls.
 

repeated string filter_control_ids = 11;

Returns:

The count of filterControlIds.

getFilterControlIds

String getFilterControlIds(int index)

 Filter controls to use in serving path.
 All triggered filter controls will be applied.
 Filter controls must be in the same data store as the serving config.
 Maximum of 20 filter controls.
 

repeated string filter_control_ids = 11;

Parameters:

index - The index of the element to return.

Returns:

The filterControlIds at the given index.

getFilterControlIdsBytes

com.google.protobuf.ByteString getFilterControlIdsBytes(int index)

 Filter controls to use in serving path.
 All triggered filter controls will be applied.
 Filter controls must be in the same data store as the serving config.
 Maximum of 20 filter controls.
 

repeated string filter_control_ids = 11;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the filterControlIds at the given index.

getBoostControlIdsList

List<String> getBoostControlIdsList()

 Boost controls to use in serving path.
 All triggered boost controls will be applied.
 Boost controls must be in the same data store as the serving config.
 Maximum of 20 boost controls.
 

repeated string boost_control_ids = 12;

Returns:

A list containing the boostControlIds.

getBoostControlIdsCount

int getBoostControlIdsCount()

 Boost controls to use in serving path.
 All triggered boost controls will be applied.
 Boost controls must be in the same data store as the serving config.
 Maximum of 20 boost controls.
 

repeated string boost_control_ids = 12;

Returns:

The count of boostControlIds.

getBoostControlIds

String getBoostControlIds(int index)

 Boost controls to use in serving path.
 All triggered boost controls will be applied.
 Boost controls must be in the same data store as the serving config.
 Maximum of 20 boost controls.
 

repeated string boost_control_ids = 12;

Parameters:

index - The index of the element to return.

Returns:

The boostControlIds at the given index.

getBoostControlIdsBytes

com.google.protobuf.ByteString getBoostControlIdsBytes(int index)

 Boost controls to use in serving path.
 All triggered boost controls will be applied.
 Boost controls must be in the same data store as the serving config.
 Maximum of 20 boost controls.
 

repeated string boost_control_ids = 12;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the boostControlIds at the given index.

getRedirectControlIdsList

List<String> getRedirectControlIdsList()

 IDs of the redirect controls. Only the first triggered redirect
 action is applied, even if multiple apply. Maximum number of
 specifications is 100.

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string redirect_control_ids = 14;

Returns:

A list containing the redirectControlIds.

getRedirectControlIdsCount

int getRedirectControlIdsCount()

 IDs of the redirect controls. Only the first triggered redirect
 action is applied, even if multiple apply. Maximum number of
 specifications is 100.

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string redirect_control_ids = 14;

Returns:

The count of redirectControlIds.

getRedirectControlIds

String getRedirectControlIds(int index)

 IDs of the redirect controls. Only the first triggered redirect
 action is applied, even if multiple apply. Maximum number of
 specifications is 100.

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string redirect_control_ids = 14;

Parameters:

index - The index of the element to return.

Returns:

The redirectControlIds at the given index.

getRedirectControlIdsBytes

com.google.protobuf.ByteString getRedirectControlIdsBytes(int index)

 IDs of the redirect controls. Only the first triggered redirect
 action is applied, even if multiple apply. Maximum number of
 specifications is 100.

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string redirect_control_ids = 14;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the redirectControlIds at the given index.

getSynonymsControlIdsList

List<String> getSynonymsControlIdsList()

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

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string synonyms_control_ids = 15;

Returns:

A list containing the synonymsControlIds.

getSynonymsControlIdsCount

int getSynonymsControlIdsCount()

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

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string synonyms_control_ids = 15;

Returns:

The count of synonymsControlIds.

getSynonymsControlIds

String getSynonymsControlIds(int index)

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

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string synonyms_control_ids = 15;

Parameters:

index - The index of the element to return.

Returns:

The synonymsControlIds at the given index.

getSynonymsControlIdsBytes

com.google.protobuf.ByteString getSynonymsControlIdsBytes(int index)

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

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string synonyms_control_ids = 15;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the synonymsControlIds at the given index.

getOnewaySynonymsControlIdsList

List<String> getOnewaySynonymsControlIdsList()

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

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string oneway_synonyms_control_ids = 16;

Returns:

A list containing the onewaySynonymsControlIds.

getOnewaySynonymsControlIdsCount

int getOnewaySynonymsControlIdsCount()

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

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string oneway_synonyms_control_ids = 16;

Returns:

The count of onewaySynonymsControlIds.

getOnewaySynonymsControlIds

String getOnewaySynonymsControlIds(int index)

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

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string oneway_synonyms_control_ids = 16;

Parameters:

index - The index of the element to return.

Returns:

The onewaySynonymsControlIds at the given index.

getOnewaySynonymsControlIdsBytes

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. Maximum number of specifications is 100.

 Can only be set if
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string oneway_synonyms_control_ids = 16;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the onewaySynonymsControlIds at the given index.

getDissociateControlIdsList

List<String> getDissociateControlIdsList()

 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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string dissociate_control_ids = 17;

Returns:

A list containing the dissociateControlIds.

getDissociateControlIdsCount

int getDissociateControlIdsCount()

 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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string dissociate_control_ids = 17;

Returns:

The count of dissociateControlIds.

getDissociateControlIds

String getDissociateControlIds(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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string dissociate_control_ids = 17;

Parameters:

index - The index of the element to return.

Returns:

The dissociateControlIds at the given index.

getDissociateControlIdsBytes

com.google.protobuf.ByteString getDissociateControlIdsBytes(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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string dissociate_control_ids = 17;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the dissociateControlIds at the given index.

getReplacementControlIdsList

List<String> 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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string replacement_control_ids = 18;

Returns:

A list containing the replacementControlIds.

getReplacementControlIdsCount

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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string replacement_control_ids = 18;

Returns:

The count of replacementControlIds.

getReplacementControlIds

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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string replacement_control_ids = 18;

Parameters:

index - The index of the element to return.

Returns:

The replacementControlIds at the given index.

getReplacementControlIdsBytes

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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

repeated string replacement_control_ids = 18;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the replacementControlIds at the given index.

getIgnoreControlIdsList

List<String> 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.
 

repeated string ignore_control_ids = 19;

Returns:

A list containing the ignoreControlIds.

getIgnoreControlIdsCount

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.
 

repeated string ignore_control_ids = 19;

Returns:

The count of ignoreControlIds.

getIgnoreControlIds

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.
 

repeated string ignore_control_ids = 19;

Parameters:

index - The index of the element to return.

Returns:

The ignoreControlIds at the given index.

getIgnoreControlIdsBytes

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.
 

repeated string ignore_control_ids = 19;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the ignoreControlIds at the given index.

hasPersonalizationSpec

boolean hasPersonalizationSpec()

 The specification for personalization spec.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
 

.google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 25;

Returns:

Whether the personalizationSpec field is set.

getPersonalizationSpec

SearchRequest.PersonalizationSpec getPersonalizationSpec()

 The specification for personalization spec.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
 

.google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 25;

Returns:

The personalizationSpec.

getPersonalizationSpecOrBuilder

SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()

 The specification for personalization spec.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
 

.google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 25;

getVerticalConfigCase

ServingConfig.VerticalConfigCase getVerticalConfigCase()