Package com.google.cloud.discoveryengine.v1alpha

Interface EngineOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Engine, Engine.Builder
@Generated public interface EngineOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasSimilarDocumentsConfig

      boolean hasSimilarDocumentsConfig()
       Additional config specs for a `similar-items` engine.
      .google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;
      Returns:
      Whether the similarDocumentsConfig field is set.

    • getSimilarDocumentsConfig

      Engine.SimilarDocumentsEngineConfig getSimilarDocumentsConfig()
       Additional config specs for a `similar-items` engine.
      .google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;
      Returns:
      The similarDocumentsConfig.

    • getSimilarDocumentsConfigOrBuilder

      Engine.SimilarDocumentsEngineConfigOrBuilder getSimilarDocumentsConfigOrBuilder()
       Additional config specs for a `similar-items` engine.
      .google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

    • hasChatEngineConfig

      boolean hasChatEngineConfig()
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;
      Returns:
      Whether the chatEngineConfig field is set.

    • getChatEngineConfig

      Engine.ChatEngineConfig getChatEngineConfig()
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;
      Returns:
      The chatEngineConfig.

    • getChatEngineConfigOrBuilder

      Engine.ChatEngineConfigOrBuilder getChatEngineConfigOrBuilder()
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

    • hasSearchEngineConfig

      boolean hasSearchEngineConfig()
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;
      Returns:
      Whether the searchEngineConfig field is set.

    • getSearchEngineConfig

      Engine.SearchEngineConfig getSearchEngineConfig()
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;
      Returns:
      The searchEngineConfig.

    • getSearchEngineConfigOrBuilder

      Engine.SearchEngineConfigOrBuilder getSearchEngineConfigOrBuilder()
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

    • hasMediaRecommendationEngineConfig

      boolean hasMediaRecommendationEngineConfig()
       Configurations for the Media Engine. Only applicable on the data
 stores with
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 and
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;
      Returns:
      Whether the mediaRecommendationEngineConfig field is set.

    • getMediaRecommendationEngineConfig

      Engine.MediaRecommendationEngineConfig getMediaRecommendationEngineConfig()
       Configurations for the Media Engine. Only applicable on the data
 stores with
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 and
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;
      Returns:
      The mediaRecommendationEngineConfig.

    • getMediaRecommendationEngineConfigOrBuilder

      Engine.MediaRecommendationEngineConfigOrBuilder getMediaRecommendationEngineConfigOrBuilder()
       Configurations for the Media Engine. Only applicable on the data
 stores with
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 and
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

    • hasRecommendationMetadata

      boolean hasRecommendationMetadata()
       Output only. Additional information of a recommendation engine. Only
 applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
      .google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the recommendationMetadata field is set.

    • getRecommendationMetadata

      Engine.RecommendationMetadata getRecommendationMetadata()
       Output only. Additional information of a recommendation engine. Only
 applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
      .google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The recommendationMetadata.

    • getRecommendationMetadataOrBuilder

      Engine.RecommendationMetadataOrBuilder getRecommendationMetadataOrBuilder()
       Output only. Additional information of a recommendation engine. Only
 applicable if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
      .google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasChatEngineMetadata

      boolean hasChatEngineMetadata()
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the chatEngineMetadata field is set.

    • getChatEngineMetadata

      Engine.ChatEngineMetadata getChatEngineMetadata()
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The chatEngineMetadata.

    • getChatEngineMetadataOrBuilder

      Engine.ChatEngineMetadataOrBuilder getChatEngineMetadataOrBuilder()
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getName

      String getName()
       Immutable. The fully qualified resource name of the engine.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.

 Format:
 `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
 engine should be 1-63 characters, and valid characters are
 /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Immutable. The fully qualified resource name of the engine.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.

 Format:
 `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
 engine should be 1-63 characters, and valid characters are
 /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Required. The display name of the engine. Should be human readable. UTF-8
 encoded string with limit of 1024 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the engine. Should be human readable. UTF-8
 encoded string with limit of 1024 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDataStoreIdsList

      List<String> getDataStoreIdsList()
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
 the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
 be associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Returns:
      A list containing the dataStoreIds.

    • getDataStoreIdsCount

      int getDataStoreIdsCount()
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
 the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
 be associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Returns:
      The count of dataStoreIds.

    • getDataStoreIds

      String getDataStoreIds(int index)
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
 the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
 be associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The dataStoreIds at the given index.

    • getDataStoreIdsBytes

      com.google.protobuf.ByteString getDataStoreIdsBytes(int index)
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1alpha.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]s in
 the same [Collection][google.cloud.discoveryengine.v1alpha.Collection] can
 be associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1alpha.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the dataStoreIds at the given index.

    • getSolutionTypeValue

      int getSolutionTypeValue()
       Required. The solutions of the engine.
      .google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for solutionType.

    • getSolutionType

      SolutionType getSolutionType()
       Required. The solutions of the engine.
      .google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The solutionType.

    • getIndustryVerticalValue

      int getIndustryVerticalValue()
       The industry vertical that the engine registers.
 The restriction of the Engine industry vertical is based on
 [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: If
 unspecified, default to `GENERIC`. Vertical on Engine has to match vertical
 of the DataStore linked to the engine.
      .google.cloud.discoveryengine.v1alpha.IndustryVertical industry_vertical = 16;
      Returns:
      The enum numeric value on the wire for industryVertical.

    • getIndustryVertical

      IndustryVertical getIndustryVertical()
       The industry vertical that the engine registers.
 The restriction of the Engine industry vertical is based on
 [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: If
 unspecified, default to `GENERIC`. Vertical on Engine has to match vertical
 of the DataStore linked to the engine.
      .google.cloud.discoveryengine.v1alpha.IndustryVertical industry_vertical = 16;
      Returns:
      The industryVertical.

    • hasCommonConfig

      boolean hasCommonConfig()
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;
      Returns:
      Whether the commonConfig field is set.

    • getCommonConfig

      Engine.CommonConfig getCommonConfig()
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;
      Returns:
      The commonConfig.

    • getCommonConfigOrBuilder

      Engine.CommonConfigOrBuilder getCommonConfigOrBuilder()
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

    • getEngineConfigCase

      Engine.EngineConfigCase getEngineConfigCase()

    • getEngineMetadataCase

      Engine.EngineMetadataCase getEngineMetadataCase()