Package com.google.cloud.discoveryengine.v1beta

Class ServingConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.ServingConfig
All Implemented Interfaces:
ServingConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ServingConfig extends com.google.protobuf.GeneratedMessage implements ServingConfigOrBuilder
 Configures metadata that is used to generate serving time results (e.g.
 search results or recommendation predictions).
 The ServingConfig is passed in the search and predict request and generates
 results.
Protobuf type google.cloud.discoveryengine.v1beta.ServingConfig
See Also:

  • Field Details

    • MEDIA_CONFIG_FIELD_NUMBER

      public static final int MEDIA_CONFIG_FIELD_NUMBER
      See Also:

    • GENERIC_CONFIG_FIELD_NUMBER

      public static final int GENERIC_CONFIG_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • SOLUTION_TYPE_FIELD_NUMBER

      public static final int SOLUTION_TYPE_FIELD_NUMBER
      See Also:

    • MODEL_ID_FIELD_NUMBER

      public static final int MODEL_ID_FIELD_NUMBER
      See Also:

    • DIVERSITY_LEVEL_FIELD_NUMBER

      public static final int DIVERSITY_LEVEL_FIELD_NUMBER
      See Also:

    • EMBEDDING_CONFIG_FIELD_NUMBER

      public static final int EMBEDDING_CONFIG_FIELD_NUMBER
      See Also:

    • RANKING_EXPRESSION_FIELD_NUMBER

      public static final int RANKING_EXPRESSION_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • FILTER_CONTROL_IDS_FIELD_NUMBER

      public static final int FILTER_CONTROL_IDS_FIELD_NUMBER
      See Also:

    • BOOST_CONTROL_IDS_FIELD_NUMBER

      public static final int BOOST_CONTROL_IDS_FIELD_NUMBER
      See Also:

    • REDIRECT_CONTROL_IDS_FIELD_NUMBER

      public static final int REDIRECT_CONTROL_IDS_FIELD_NUMBER
      See Also:

    • SYNONYMS_CONTROL_IDS_FIELD_NUMBER

      public static final int SYNONYMS_CONTROL_IDS_FIELD_NUMBER
      See Also:

    • ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER

      public static final int ONEWAY_SYNONYMS_CONTROL_IDS_FIELD_NUMBER
      See Also:

    • DISSOCIATE_CONTROL_IDS_FIELD_NUMBER

      public static final int DISSOCIATE_CONTROL_IDS_FIELD_NUMBER
      See Also:

    • REPLACEMENT_CONTROL_IDS_FIELD_NUMBER

      public static final int REPLACEMENT_CONTROL_IDS_FIELD_NUMBER
      See Also:

    • IGNORE_CONTROL_IDS_FIELD_NUMBER

      public static final int IGNORE_CONTROL_IDS_FIELD_NUMBER
      See Also:

    • PERSONALIZATION_SPEC_FIELD_NUMBER

      public static final int PERSONALIZATION_SPEC_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getVerticalConfigCase

      public ServingConfig.VerticalConfigCase getVerticalConfigCase()
      Specified by:
      getVerticalConfigCase in interface ServingConfigOrBuilder

    • hasMediaConfig

      public boolean hasMediaConfig()
       The MediaConfig of the serving configuration.
      .google.cloud.discoveryengine.v1beta.ServingConfig.MediaConfig media_config = 7;
      Specified by:
      hasMediaConfig in interface ServingConfigOrBuilder
      Returns:
      Whether the mediaConfig field is set.

    • getMediaConfig

      public ServingConfig.MediaConfig getMediaConfig()
       The MediaConfig of the serving configuration.
      .google.cloud.discoveryengine.v1beta.ServingConfig.MediaConfig media_config = 7;
      Specified by:
      getMediaConfig in interface ServingConfigOrBuilder
      Returns:
      The mediaConfig.

    • getMediaConfigOrBuilder

      public ServingConfig.MediaConfigOrBuilder getMediaConfigOrBuilder()
       The MediaConfig of the serving configuration.
      .google.cloud.discoveryengine.v1beta.ServingConfig.MediaConfig media_config = 7;
      Specified by:
      getMediaConfigOrBuilder in interface ServingConfigOrBuilder

    • hasGenericConfig

      public boolean hasGenericConfig()
       The GenericConfig of the serving configuration.
      .google.cloud.discoveryengine.v1beta.ServingConfig.GenericConfig generic_config = 10;
      Specified by:
      hasGenericConfig in interface ServingConfigOrBuilder
      Returns:
      Whether the genericConfig field is set.

    • getGenericConfig

      public ServingConfig.GenericConfig getGenericConfig()
       The GenericConfig of the serving configuration.
      .google.cloud.discoveryengine.v1beta.ServingConfig.GenericConfig generic_config = 10;
      Specified by:
      getGenericConfig in interface ServingConfigOrBuilder
      Returns:
      The genericConfig.

    • getGenericConfigOrBuilder

      public ServingConfig.GenericConfigOrBuilder getGenericConfigOrBuilder()
       The GenericConfig of the serving configuration.
      .google.cloud.discoveryengine.v1beta.ServingConfig.GenericConfig generic_config = 10;
      Specified by:
      getGenericConfigOrBuilder in interface ServingConfigOrBuilder

    • getName

      public 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];
      Specified by:
      getName in interface ServingConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      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 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];
      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 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];
      Specified by:
      getDisplayNameBytes in interface ServingConfigOrBuilder
      Returns:
      The bytes for displayName.

    • getSolutionTypeValue

      public 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];
      Specified by:
      getSolutionTypeValue in interface ServingConfigOrBuilder
      Returns:
      The enum numeric value on the wire for solutionType.

    • getSolutionType

      public 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];
      Specified by:
      getSolutionType in interface ServingConfigOrBuilder
      Returns:
      The solutionType.

    • getModelId

      public 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;
      Specified by:
      getModelId in interface ServingConfigOrBuilder
      Returns:
      The modelId.

    • getModelIdBytes

      public 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;
      Specified by:
      getModelIdBytes in interface ServingConfigOrBuilder
      Returns:
      The bytes for modelId.

    • 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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
      string diversity_level = 5;
      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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
      string diversity_level = 5;
      Specified by:
      getDiversityLevelBytes in interface ServingConfigOrBuilder
      Returns:
      The bytes for diversityLevel.

    • hasEmbeddingConfig

      public 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;
      Specified by:
      hasEmbeddingConfig in interface ServingConfigOrBuilder
      Returns:
      Whether the embeddingConfig field is set.

    • getEmbeddingConfig

      public 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;
      Specified by:
      getEmbeddingConfig in interface ServingConfigOrBuilder
      Returns:
      The embeddingConfig.

    • getEmbeddingConfigOrBuilder

      public 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;
      Specified by:
      getEmbeddingConfigOrBuilder in interface ServingConfigOrBuilder

    • getRankingExpression

      public 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;
      Specified by:
      getRankingExpression in interface ServingConfigOrBuilder
      Returns:
      The rankingExpression.

    • getRankingExpressionBytes

      public 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;
      Specified by:
      getRankingExpressionBytes in interface ServingConfigOrBuilder
      Returns:
      The bytes for rankingExpression.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. ServingConfig created timestamp.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ServingConfigOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. ServingConfig created timestamp.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ServingConfigOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. ServingConfig created timestamp.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ServingConfigOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. ServingConfig updated timestamp.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface ServingConfigOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. ServingConfig updated timestamp.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface ServingConfigOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. ServingConfig updated timestamp.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface ServingConfigOrBuilder

    • getFilterControlIdsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getFilterControlIdsList in interface ServingConfigOrBuilder
      Returns:
      A list containing the filterControlIds.

    • getFilterControlIdsCount

      public 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;
      Specified by:
      getFilterControlIdsCount in interface ServingConfigOrBuilder
      Returns:
      The count of filterControlIds.

    • getFilterControlIds

      public 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;
      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)
       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;
      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.

    • getBoostControlIdsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getBoostControlIdsList in interface ServingConfigOrBuilder
      Returns:
      A list containing the boostControlIds.

    • getBoostControlIdsCount

      public 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;
      Specified by:
      getBoostControlIdsCount in interface ServingConfigOrBuilder
      Returns:
      The count of boostControlIds.

    • getBoostControlIds

      public 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;
      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)
       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;
      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.

    • getRedirectControlIdsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getRedirectControlIdsList in interface ServingConfigOrBuilder
      Returns:
      A list containing the redirectControlIds.

    • getRedirectControlIdsCount

      public 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;
      Specified by:
      getRedirectControlIdsCount in interface ServingConfigOrBuilder
      Returns:
      The count of redirectControlIds.

    • getRedirectControlIds

      public 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;
      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)
       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;
      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.

    • getSynonymsControlIdsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getSynonymsControlIdsList in interface ServingConfigOrBuilder
      Returns:
      A list containing the synonymsControlIds.

    • getSynonymsControlIdsCount

      public 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;
      Specified by:
      getSynonymsControlIdsCount in interface ServingConfigOrBuilder
      Returns:
      The count of synonymsControlIds.

    • getSynonymsControlIds

      public 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;
      Specified by:
      getSynonymsControlIds in interface ServingConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The synonymsControlIds at the given index.

    • getSynonymsControlIdsBytes

      public 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;
      Specified by:
      getSynonymsControlIdsBytes in interface ServingConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the synonymsControlIds 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. 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;
      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. 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;
      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. 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;
      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. 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;
      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.

    • getDissociateControlIdsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getDissociateControlIdsList in interface ServingConfigOrBuilder
      Returns:
      A list containing the dissociateControlIds.

    • getDissociateControlIdsCount

      public 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;
      Specified by:
      getDissociateControlIdsCount in interface ServingConfigOrBuilder
      Returns:
      The count of dissociateControlIds.

    • getDissociateControlIds

      public 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;
      Specified by:
      getDissociateControlIds in interface ServingConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The dissociateControlIds at the given index.

    • getDissociateControlIdsBytes

      public 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;
      Specified by:
      getDissociateControlIdsBytes in interface ServingConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the dissociateControlIds 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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated string replacement_control_ids = 18;
      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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated string replacement_control_ids = 18;
      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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated string replacement_control_ids = 18;
      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
 [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated string replacement_control_ids = 18;
      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.
      repeated string ignore_control_ids = 19;
      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.
      repeated string ignore_control_ids = 19;
      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.
      repeated string ignore_control_ids = 19;
      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.
      repeated string ignore_control_ids = 19;
      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.

    • hasPersonalizationSpec

      public 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;
      Specified by:
      hasPersonalizationSpec in interface ServingConfigOrBuilder
      Returns:
      Whether the personalizationSpec field is set.

    • getPersonalizationSpec

      public 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;
      Specified by:
      getPersonalizationSpec in interface ServingConfigOrBuilder
      Returns:
      The personalizationSpec.

    • getPersonalizationSpecOrBuilder

      public 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;
      Specified by:
      getPersonalizationSpecOrBuilder in interface ServingConfigOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public ServingConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder