Interface EngineOrBuilder (0.31.0)

Version 0.31.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface EngineOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChatEngineConfig()

public abstract Engine.ChatEngineConfig getChatEngineConfig()

Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

Returns
Type	Description
Engine.ChatEngineConfig	The chatEngineConfig.

getChatEngineConfigOrBuilder()

public abstract Engine.ChatEngineConfigOrBuilder getChatEngineConfigOrBuilder()

Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

Returns
Type	Description
Engine.ChatEngineConfigOrBuilder

getChatEngineMetadata()

public abstract Engine.ChatEngineMetadata getChatEngineMetadata()

Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Engine.ChatEngineMetadata	The chatEngineMetadata.

getChatEngineMetadataOrBuilder()

public abstract Engine.ChatEngineMetadataOrBuilder getChatEngineMetadataOrBuilder()

Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Engine.ChatEngineMetadataOrBuilder

getCommonConfig()

public abstract Engine.CommonConfig getCommonConfig()

Common config spec that specifies the metadata of the engine.

.google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

Returns
Type	Description
Engine.CommonConfig	The commonConfig.

getCommonConfigOrBuilder()

public abstract Engine.CommonConfigOrBuilder getCommonConfigOrBuilder()

Common config spec that specifies the metadata of the engine.

.google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

Returns
Type	Description
Engine.CommonConfigOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp the Recommendation Engine was created at.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp the Recommendation Engine was created at.

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

Returns
Type	Description
TimestampOrBuilder

getDataStoreIds(int index)

public abstract String getDataStoreIds(int index)

The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.

repeated string data_store_ids = 5;

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

Returns
Type	Description
String	The dataStoreIds at the given index.

getDataStoreIdsBytes(int index)

public abstract ByteString getDataStoreIdsBytes(int index)

The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.

repeated string data_store_ids = 5;

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

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

getDataStoreIdsCount()

public abstract int getDataStoreIdsCount()

The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.

repeated string data_store_ids = 5;

Returns
Type	Description
int	The count of dataStoreIds.

getDataStoreIdsList()

public abstract List<String> getDataStoreIdsList()

The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.

repeated string data_store_ids = 5;

Returns
Type	Description
List<String>	A list containing the dataStoreIds.

getDisplayName()

public abstract 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
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract 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
Type	Description
ByteString	The bytes for displayName.

getEngineConfigCase()

public abstract Engine.EngineConfigCase getEngineConfigCase()

Returns
Type	Description
Engine.EngineConfigCase

getEngineMetadataCase()

public abstract Engine.EngineMetadataCase getEngineMetadataCase()

Returns
Type	Description
Engine.EngineMetadataCase

getIndustryVertical()

public abstract IndustryVertical getIndustryVertical()

The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine.

.google.cloud.discoveryengine.v1alpha.IndustryVertical industry_vertical = 16;

Returns
Type	Description
IndustryVertical	The industryVertical.

getIndustryVerticalValue()

public abstract int getIndustryVerticalValue()

The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine.

.google.cloud.discoveryengine.v1alpha.IndustryVertical industry_vertical = 16;

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

getMediaRecommendationEngineConfig()

public abstract Engine.MediaRecommendationEngineConfig getMediaRecommendationEngineConfig()

Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Returns
Type	Description
Engine.MediaRecommendationEngineConfig	The mediaRecommendationEngineConfig.

getMediaRecommendationEngineConfigOrBuilder()

public abstract Engine.MediaRecommendationEngineConfigOrBuilder getMediaRecommendationEngineConfigOrBuilder()

Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Returns
Type	Description
Engine.MediaRecommendationEngineConfigOrBuilder

getName()

public abstract 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*/. Otherwise, an INVALID_ARGUMENT error is returned.

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

Returns
Type	Description
String	The name.

getNameBytes()

public abstract 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*/. Otherwise, an INVALID_ARGUMENT error is returned.

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

Returns
Type	Description
ByteString	The bytes for name.

getRecommendationMetadata()

public abstract Engine.RecommendationMetadata getRecommendationMetadata()

Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Engine.RecommendationMetadata	The recommendationMetadata.

getRecommendationMetadataOrBuilder()

public abstract Engine.RecommendationMetadataOrBuilder getRecommendationMetadataOrBuilder()

Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Engine.RecommendationMetadataOrBuilder

getSearchEngineConfig()

public abstract Engine.SearchEngineConfig getSearchEngineConfig()

Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

.google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

Returns
Type	Description
Engine.SearchEngineConfig	The searchEngineConfig.

getSearchEngineConfigOrBuilder()

public abstract Engine.SearchEngineConfigOrBuilder getSearchEngineConfigOrBuilder()

Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

.google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

Returns
Type	Description
Engine.SearchEngineConfigOrBuilder

getSimilarDocumentsConfig()

public abstract Engine.SimilarDocumentsEngineConfig getSimilarDocumentsConfig()

Additional config specs for a similar-items engine.

.google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

Returns
Type	Description
Engine.SimilarDocumentsEngineConfig	The similarDocumentsConfig.

getSimilarDocumentsConfigOrBuilder()

public abstract Engine.SimilarDocumentsEngineConfigOrBuilder getSimilarDocumentsConfigOrBuilder()

Additional config specs for a similar-items engine.

.google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

Returns
Type	Description
Engine.SimilarDocumentsEngineConfigOrBuilder

getSolutionType()

public abstract SolutionType getSolutionType()

Required. The solutions of the engine.

.google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
SolutionType	The solutionType.

getSolutionTypeValue()

public abstract int getSolutionTypeValue()

Required. The solutions of the engine.

.google.cloud.discoveryengine.v1alpha.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];

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

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Timestamp the Recommendation Engine was last updated.

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp the Recommendation Engine was last updated.

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

Returns
Type	Description
TimestampOrBuilder

hasChatEngineConfig()

public abstract boolean hasChatEngineConfig()

Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig chat_engine_config = 11;

Returns
Type	Description
boolean	Whether the chatEngineConfig field is set.

hasChatEngineMetadata()

public abstract boolean hasChatEngineMetadata()

Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

.google.cloud.discoveryengine.v1alpha.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the chatEngineMetadata field is set.

hasCommonConfig()

public abstract boolean hasCommonConfig()

Common config spec that specifies the metadata of the engine.

.google.cloud.discoveryengine.v1alpha.Engine.CommonConfig common_config = 15;

Returns
Type	Description
boolean	Whether the commonConfig field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp the Recommendation Engine was created at.

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasMediaRecommendationEngineConfig()

public abstract boolean hasMediaRecommendationEngineConfig()

Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Returns
Type	Description
boolean	Whether the mediaRecommendationEngineConfig field is set.

hasRecommendationMetadata()

public abstract boolean hasRecommendationMetadata()

Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata recommendation_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the recommendationMetadata field is set.

hasSearchEngineConfig()

public abstract boolean hasSearchEngineConfig()

Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

.google.cloud.discoveryengine.v1alpha.Engine.SearchEngineConfig search_engine_config = 13;

Returns
Type	Description
boolean	Whether the searchEngineConfig field is set.

hasSimilarDocumentsConfig()

public abstract boolean hasSimilarDocumentsConfig()

Additional config specs for a similar-items engine.

.google.cloud.discoveryengine.v1alpha.Engine.SimilarDocumentsEngineConfig similar_documents_config = 9;

Returns
Type	Description
boolean	Whether the similarDocumentsConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Timestamp the Recommendation Engine was last updated.

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

Returns
Type	Description
boolean	Whether the updateTime field is set.