Interface EngineOrBuilder (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 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

containsConnectorTenantInfo(String key)

public abstract boolean containsConnectorTenantInfo(String key)

Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.

map<string, string> connector_tenant_info = 42 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsFeatures(String key)

public abstract boolean containsFeatures(String key)

Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

• *: all features, if it's present, all other feature state settings are ignored.
• agent-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsModelConfigs(String key)

public abstract boolean containsModelConfigs(String key)

Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

map<string, .google.cloud.discoveryengine.v1beta.Engine.ModelState> model_configs = 37 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAgentGatewaySetting()

public abstract AgentGatewaySetting getAgentGatewaySetting()

Optional. The agent gateway setting for the engine.

.google.cloud.discoveryengine.v1beta.AgentGatewaySetting agent_gateway_setting = 43 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AgentGatewaySetting	The agentGatewaySetting.

getAgentGatewaySettingOrBuilder()

public abstract AgentGatewaySettingOrBuilder getAgentGatewaySettingOrBuilder()

Optional. The agent gateway setting for the engine.

.google.cloud.discoveryengine.v1beta.AgentGatewaySetting agent_gateway_setting = 43 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AgentGatewaySettingOrBuilder

getAppType()

public abstract Engine.AppType getAppType()

Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.

.google.cloud.discoveryengine.v1beta.Engine.AppType app_type = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
Engine.AppType	The appType.

getAppTypeValue()

public abstract int getAppTypeValue()

Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.

.google.cloud.discoveryengine.v1beta.Engine.AppType app_type = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

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

getChatEngineConfig()

public abstract Engine.ChatEngineConfig getChatEngineConfig()

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

.google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Engine.ChatEngineMetadataOrBuilder

getCmekConfig()

public abstract CmekConfig getCmekConfig()

Output only. CMEK-related information for the Engine.

.google.cloud.discoveryengine.v1beta.CmekConfig cmek_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
CmekConfig	The cmekConfig.

getCmekConfigOrBuilder()

public abstract CmekConfigOrBuilder getCmekConfigOrBuilder()

Output only. CMEK-related information for the Engine.

.google.cloud.discoveryengine.v1beta.CmekConfig cmek_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
CmekConfigOrBuilder

getCommonConfig()

public abstract Engine.CommonConfig getCommonConfig()

Common config spec that specifies the metadata of the engine.

.google.cloud.discoveryengine.v1beta.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.v1beta.Engine.CommonConfig common_config = 15;

Returns
Type	Description
Engine.CommonConfigOrBuilder

getConfigurableBillingApproach()

public abstract Engine.ConfigurableBillingApproach getConfigurableBillingApproach()

Optional. Configuration for configurable billing approach.

.google.cloud.discoveryengine.v1beta.Engine.ConfigurableBillingApproach configurable_billing_approach = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Engine.ConfigurableBillingApproach	The configurableBillingApproach.

getConfigurableBillingApproachValue()

public abstract int getConfigurableBillingApproachValue()

Optional. Configuration for configurable billing approach.

.google.cloud.discoveryengine.v1beta.Engine.ConfigurableBillingApproach configurable_billing_approach = 36 [(.google.api.field_behavior) = OPTIONAL];

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

getConnectorTenantInfo() (deprecated)

public abstract Map<String,String> getConnectorTenantInfo()

Use #getConnectorTenantInfoMap() instead.

Returns
Type	Description
Map<String,String>

getConnectorTenantInfoCount()

public abstract int getConnectorTenantInfoCount()

Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.

map<string, string> connector_tenant_info = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getConnectorTenantInfoMap()

public abstract Map<String,String> getConnectorTenantInfoMap()

Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.

map<string, string> connector_tenant_info = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getConnectorTenantInfoOrDefault(String key, String defaultValue)

public abstract String getConnectorTenantInfoOrDefault(String key, String defaultValue)

Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.

map<string, string> connector_tenant_info = 42 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getConnectorTenantInfoOrThrow(String key)

public abstract String getConnectorTenantInfoOrThrow(String key)

Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.

map<string, string> connector_tenant_info = 42 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

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)

Optional. 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 initializations.

repeated string data_store_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. 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 initializations.

repeated string data_store_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

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()

Optional. 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 initializations.

repeated string data_store_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of dataStoreIds.

getDataStoreIdsList()

public abstract List<String> getDataStoreIdsList()

Optional. 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 initializations.

repeated string data_store_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

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

getDisableAnalytics()

public abstract boolean getDisableAnalytics()

Optional. Whether to disable analytics for searches performed on this engine.

bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The disableAnalytics.

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

getFeatures() (deprecated)

public abstract Map<String,Engine.FeatureState> getFeatures()

Use #getFeaturesMap() instead.

Returns
Type	Description
Map<String,FeatureState>

getFeaturesCount()

public abstract int getFeaturesCount()

Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

• *: all features, if it's present, all other feature state settings are ignored.
• agent-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getFeaturesMap()

public abstract Map<String,Engine.FeatureState> getFeaturesMap()

Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

• *: all features, if it's present, all other feature state settings are ignored.
• agent-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,FeatureState>

getFeaturesOrDefault(String key, Engine.FeatureState defaultValue)

public abstract Engine.FeatureState getFeaturesOrDefault(String key, Engine.FeatureState defaultValue)

Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

• *: all features, if it's present, all other feature state settings are ignored.
• agent-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	Engine.FeatureState

Returns
Type	Description
Engine.FeatureState

getFeaturesOrThrow(String key)

public abstract Engine.FeatureState getFeaturesOrThrow(String key)

Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

• *: all features, if it's present, all other feature state settings are ignored.
• agent-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
Engine.FeatureState

getFeaturesValue() (deprecated)

public abstract Map<String,Integer> getFeaturesValue()

Use #getFeaturesValueMap() instead.

Returns
Type	Description
Map<String,Integer>

getFeaturesValueMap()

public abstract Map<String,Integer> getFeaturesValueMap()

Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

• *: all features, if it's present, all other feature state settings are ignored.
• agent-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,Integer>

getFeaturesValueOrDefault(String key, int defaultValue)

public abstract int getFeaturesValueOrDefault(String key, int defaultValue)

Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

• *: all features, if it's present, all other feature state settings are ignored.
• agent-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	int

Returns
Type	Description
int

getFeaturesValueOrThrow(String key)

public abstract int getFeaturesValueOrThrow(String key)

Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

• *: all features, if it's present, all other feature state settings are ignored.
• agent-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
int

getIndustryVertical()

public abstract IndustryVertical getIndustryVertical()

Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.

.google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
IndustryVertical	The industryVertical.

getIndustryVerticalValue()

public abstract int getIndustryVerticalValue()

Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.

.google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 16 [(.google.api.field_behavior) = OPTIONAL];

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

getKnowledgeGraphConfig()

public abstract Engine.KnowledgeGraphConfig getKnowledgeGraphConfig()

Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

.google.cloud.discoveryengine.v1beta.Engine.KnowledgeGraphConfig knowledge_graph_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Engine.KnowledgeGraphConfig	The knowledgeGraphConfig.

getKnowledgeGraphConfigOrBuilder()

public abstract Engine.KnowledgeGraphConfigOrBuilder getKnowledgeGraphConfigOrBuilder()

Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

.google.cloud.discoveryengine.v1beta.Engine.KnowledgeGraphConfig knowledge_graph_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Engine.KnowledgeGraphConfigOrBuilder

getMarketplaceAgentVisibility()

public abstract Engine.MarketplaceAgentVisibility getMarketplaceAgentVisibility()

Optional. The visibility of marketplace agents in the agent gallery.

.google.cloud.discoveryengine.v1beta.Engine.MarketplaceAgentVisibility marketplace_agent_visibility = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Engine.MarketplaceAgentVisibility	The marketplaceAgentVisibility.

getMarketplaceAgentVisibilityValue()

public abstract int getMarketplaceAgentVisibilityValue()

Optional. The visibility of marketplace agents in the agent gallery.

.google.cloud.discoveryengine.v1beta.Engine.MarketplaceAgentVisibility marketplace_agent_visibility = 44 [(.google.api.field_behavior) = OPTIONAL];

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

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.v1beta.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.v1beta.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Returns
Type	Description
Engine.MediaRecommendationEngineConfigOrBuilder

getModelConfigs() (deprecated)

public abstract Map<String,Engine.ModelState> getModelConfigs()

Use #getModelConfigsMap() instead.

Returns
Type	Description
Map<String,ModelState>

getModelConfigsCount()

public abstract int getModelConfigsCount()

Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

map<string, .google.cloud.discoveryengine.v1beta.Engine.ModelState> model_configs = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getModelConfigsMap()

public abstract Map<String,Engine.ModelState> getModelConfigsMap()

Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

map<string, .google.cloud.discoveryengine.v1beta.Engine.ModelState> model_configs = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,ModelState>

getModelConfigsOrDefault(String key, Engine.ModelState defaultValue)

public abstract Engine.ModelState getModelConfigsOrDefault(String key, Engine.ModelState defaultValue)

Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

map<string, .google.cloud.discoveryengine.v1beta.Engine.ModelState> model_configs = 37 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	Engine.ModelState

Returns
Type	Description
Engine.ModelState

getModelConfigsOrThrow(String key)

public abstract Engine.ModelState getModelConfigsOrThrow(String key)

Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

map<string, .google.cloud.discoveryengine.v1beta.Engine.ModelState> model_configs = 37 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
Engine.ModelState

getModelConfigsValue() (deprecated)

public abstract Map<String,Integer> getModelConfigsValue()

Use #getModelConfigsValueMap() instead.

Returns
Type	Description
Map<String,Integer>

getModelConfigsValueMap()

public abstract Map<String,Integer> getModelConfigsValueMap()

Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

map<string, .google.cloud.discoveryengine.v1beta.Engine.ModelState> model_configs = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,Integer>

getModelConfigsValueOrDefault(String key, int defaultValue)

public abstract int getModelConfigsValueOrDefault(String key, int defaultValue)

Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

map<string, .google.cloud.discoveryengine.v1beta.Engine.ModelState> model_configs = 37 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	int

Returns
Type	Description
int

getModelConfigsValueOrThrow(String key)

public abstract int getModelConfigsValueOrThrow(String key)

Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

map<string, .google.cloud.discoveryengine.v1beta.Engine.ModelState> model_configs = 37 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
int

getName()

public abstract String getName()

Immutable. Identifier. 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}/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, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. Identifier. 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}/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, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getObservabilityConfig()

public abstract ObservabilityConfig getObservabilityConfig()

Optional. Observability config for the engine.

.google.cloud.discoveryengine.v1beta.ObservabilityConfig observability_config = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ObservabilityConfig	The observabilityConfig.

getObservabilityConfigOrBuilder()

public abstract ObservabilityConfigOrBuilder getObservabilityConfigOrBuilder()

Optional. Observability config for the engine.

.google.cloud.discoveryengine.v1beta.ObservabilityConfig observability_config = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ObservabilityConfigOrBuilder

getProcurementContactEmails(int index)

public abstract String getProcurementContactEmails(int index)

Optional. The emails of the procurement contacts.

repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
String	The procurementContactEmails at the given index.

getProcurementContactEmailsBytes(int index)

public abstract ByteString getProcurementContactEmailsBytes(int index)

Optional. The emails of the procurement contacts.

repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];

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

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

getProcurementContactEmailsCount()

public abstract int getProcurementContactEmailsCount()

Optional. The emails of the procurement contacts.

repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of procurementContactEmails.

getProcurementContactEmailsList()

public abstract List<String> getProcurementContactEmailsList()

Optional. The emails of the procurement contacts.

repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];

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

getSearchEngineConfig()

public abstract Engine.SearchEngineConfig getSearchEngineConfig()

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

.google.cloud.discoveryengine.v1beta.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.v1beta.Engine.SearchEngineConfig search_engine_config = 13;

Returns
Type	Description
Engine.SearchEngineConfigOrBuilder

getSolutionType()

public abstract SolutionType getSolutionType()

Required. The solutions of the engine.

.google.cloud.discoveryengine.v1beta.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.v1beta.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

hasAgentGatewaySetting()

public abstract boolean hasAgentGatewaySetting()

Optional. The agent gateway setting for the engine.

.google.cloud.discoveryengine.v1beta.AgentGatewaySetting agent_gateway_setting = 43 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the agentGatewaySetting field is set.

hasChatEngineConfig()

public abstract boolean hasChatEngineConfig()

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

.google.cloud.discoveryengine.v1beta.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.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the chatEngineMetadata field is set.

hasCmekConfig()

public abstract boolean hasCmekConfig()

Output only. CMEK-related information for the Engine.

.google.cloud.discoveryengine.v1beta.CmekConfig cmek_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the cmekConfig field is set.

hasCommonConfig()

public abstract boolean hasCommonConfig()

Common config spec that specifies the metadata of the engine.

.google.cloud.discoveryengine.v1beta.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.

hasKnowledgeGraphConfig()

public abstract boolean hasKnowledgeGraphConfig()

Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

.google.cloud.discoveryengine.v1beta.Engine.KnowledgeGraphConfig knowledge_graph_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the knowledgeGraphConfig 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.v1beta.Engine.MediaRecommendationEngineConfig media_recommendation_engine_config = 14;

Returns
Type	Description
boolean	Whether the mediaRecommendationEngineConfig field is set.

hasObservabilityConfig()

public abstract boolean hasObservabilityConfig()

Optional. Observability config for the engine.

.google.cloud.discoveryengine.v1beta.ObservabilityConfig observability_config = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the observabilityConfig 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.v1beta.Engine.SearchEngineConfig search_engine_config = 13;

Returns
Type	Description
boolean	Whether the searchEngineConfig 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.