public static final class Engine.Builder extends GeneratedMessage.Builder<Engine.Builder> implements EngineOrBuilderMetadata that describes the training and serving parameters of an Engine.
Protobuf type google.cloud.discoveryengine.v1beta.Engine
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Engine.BuilderImplements
EngineOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDataStoreIds(Iterable<String> values)
public Engine.Builder addAllDataStoreIds(Iterable<String> values)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 |
values |
Iterable<String>The dataStoreIds to add. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
addAllProcurementContactEmails(Iterable<String> values)
public Engine.Builder addAllProcurementContactEmails(Iterable<String> values)Optional. The emails of the procurement contacts.
repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The procurementContactEmails to add. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
addDataStoreIds(String value)
public Engine.Builder addDataStoreIds(String value)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 |
value |
StringThe dataStoreIds to add. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
addDataStoreIdsBytes(ByteString value)
public Engine.Builder addDataStoreIdsBytes(ByteString value)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 |
value |
ByteStringThe bytes of the dataStoreIds to add. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
addProcurementContactEmails(String value)
public Engine.Builder addProcurementContactEmails(String value)Optional. The emails of the procurement contacts.
repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe procurementContactEmails to add. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
addProcurementContactEmailsBytes(ByteString value)
public Engine.Builder addProcurementContactEmailsBytes(ByteString value)Optional. The emails of the procurement contacts.
repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the procurementContactEmails to add. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
build()
public Engine build()| Returns | |
|---|---|
| Type | Description |
Engine |
|
buildPartial()
public Engine buildPartial()| Returns | |
|---|---|
| Type | Description |
Engine |
|
clear()
public Engine.Builder clear()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearAgentGatewaySetting()
public Engine.Builder clearAgentGatewaySetting()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 |
Engine.Builder |
|
clearAppType()
public Engine.Builder clearAppType()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.Builder |
This builder for chaining. |
clearChatEngineConfig()
public Engine.Builder clearChatEngineConfig()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.Builder |
|
clearChatEngineMetadata()
public Engine.Builder clearChatEngineMetadata()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.Builder |
|
clearCmekConfig()
public Engine.Builder clearCmekConfig()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 |
Engine.Builder |
|
clearCommonConfig()
public Engine.Builder clearCommonConfig()Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearConfigurableBillingApproach()
public Engine.Builder clearConfigurableBillingApproach()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.Builder |
This builder for chaining. |
clearConnectorTenantInfo()
public Engine.Builder clearConnectorTenantInfo()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearCreateTime()
public Engine.Builder clearCreateTime()Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearDataStoreIds()
public Engine.Builder clearDataStoreIds()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 |
Engine.Builder |
This builder for chaining. |
clearDisableAnalytics()
public Engine.Builder clearDisableAnalytics()Optional. Whether to disable analytics for searches performed on this engine.
bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
clearDisplayName()
public Engine.Builder clearDisplayName()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 |
Engine.Builder |
This builder for chaining. |
clearEngineConfig()
public Engine.Builder clearEngineConfig()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearEngineMetadata()
public Engine.Builder clearEngineMetadata()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearFeatures()
public Engine.Builder clearFeatures()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearIndustryVertical()
public Engine.Builder clearIndustryVertical()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 |
Engine.Builder |
This builder for chaining. |
clearKnowledgeGraphConfig()
public Engine.Builder clearKnowledgeGraphConfig()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.Builder |
|
clearMarketplaceAgentVisibility()
public Engine.Builder clearMarketplaceAgentVisibility()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.Builder |
This builder for chaining. |
clearMediaRecommendationEngineConfig()
public Engine.Builder clearMediaRecommendationEngineConfig()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.Builder |
|
clearModelConfigs()
public Engine.Builder clearModelConfigs()| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearName()
public Engine.Builder clearName()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 |
Engine.Builder |
This builder for chaining. |
clearObservabilityConfig()
public Engine.Builder clearObservabilityConfig()Optional. Observability config for the engine.
.google.cloud.discoveryengine.v1beta.ObservabilityConfig observability_config = 39 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
clearProcurementContactEmails()
public Engine.Builder clearProcurementContactEmails()Optional. The emails of the procurement contacts.
repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
clearSearchEngineConfig()
public Engine.Builder clearSearchEngineConfig()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.Builder |
|
clearSolutionType()
public Engine.Builder clearSolutionType()Required. The solutions of the engine.
.google.cloud.discoveryengine.v1beta.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
clearUpdateTime()
public Engine.Builder clearUpdateTime()Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
containsConnectorTenantInfo(String key)
public 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 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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-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 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 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. |
getAgentGatewaySettingBuilder()
public AgentGatewaySetting.Builder getAgentGatewaySettingBuilder()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.Builder |
|
getAgentGatewaySettingOrBuilder()
public 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 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 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 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. |
getChatEngineConfigBuilder()
public Engine.ChatEngineConfig.Builder getChatEngineConfigBuilder()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.Builder |
|
getChatEngineConfigOrBuilder()
public 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 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. |
getChatEngineMetadataBuilder()
public Engine.ChatEngineMetadata.Builder getChatEngineMetadataBuilder()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.Builder |
|
getChatEngineMetadataOrBuilder()
public 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 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. |
getCmekConfigBuilder()
public CmekConfig.Builder getCmekConfigBuilder()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.Builder |
|
getCmekConfigOrBuilder()
public 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 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. |
getCommonConfigBuilder()
public Engine.CommonConfig.Builder getCommonConfigBuilder()Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;
| Returns | |
|---|---|
| Type | Description |
Engine.CommonConfig.Builder |
|
getCommonConfigOrBuilder()
public 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 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 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 Map<String,String> getConnectorTenantInfo()Use #getConnectorTenantInfoMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getConnectorTenantInfoCount()
public 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 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 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 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 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public 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 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The dataStoreIds at the given index. |
getDataStoreIdsBytes(int index)
public 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the dataStoreIds at the given index. |
getDataStoreIdsCount()
public 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 ProtocolStringList 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 |
ProtocolStringList |
A list containing the dataStoreIds. |
getDefaultInstanceForType()
public Engine getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Engine |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisableAnalytics()
public 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 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 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 Engine.EngineConfigCase getEngineConfigCase()| Returns | |
|---|---|
| Type | Description |
Engine.EngineConfigCase |
|
getEngineMetadataCase()
public Engine.EngineMetadataCase getEngineMetadataCase()| Returns | |
|---|---|
| Type | Description |
Engine.EngineMetadataCase |
|
getFeatures() (deprecated)
public Map<String,Engine.FeatureState> getFeatures()Use #getFeaturesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,FeatureState> |
|
getFeaturesCount()
public 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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-product-intelligence
map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getFeaturesMap()
public 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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-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 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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-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 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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-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 Map<String,Integer> getFeaturesValue()Use #getFeaturesValueMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Integer> |
|
getFeaturesValueMap()
public 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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-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 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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-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 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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-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 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 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 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. |
getKnowledgeGraphConfigBuilder()
public Engine.KnowledgeGraphConfig.Builder getKnowledgeGraphConfigBuilder()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.Builder |
|
getKnowledgeGraphConfigOrBuilder()
public 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 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 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 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. |
getMediaRecommendationEngineConfigBuilder()
public Engine.MediaRecommendationEngineConfig.Builder getMediaRecommendationEngineConfigBuilder()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.Builder |
|
getMediaRecommendationEngineConfigOrBuilder()
public 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 Map<String,Engine.ModelState> getModelConfigs()Use #getModelConfigsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,ModelState> |
|
getModelConfigsCount()
public 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 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 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 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 Map<String,Integer> getModelConfigsValue()Use #getModelConfigsValueMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Integer> |
|
getModelConfigsValueMap()
public 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 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 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 |
|
getMutableConnectorTenantInfo() (deprecated)
public Map<String,String> getMutableConnectorTenantInfo()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMutableFeatures() (deprecated)
public Map<String,Engine.FeatureState> getMutableFeatures()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,FeatureState> |
|
getMutableFeaturesValue() (deprecated)
public Map<String,Integer> getMutableFeaturesValue()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Integer> |
|
getMutableModelConfigs() (deprecated)
public Map<String,Engine.ModelState> getMutableModelConfigs()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,ModelState> |
|
getMutableModelConfigsValue() (deprecated)
public Map<String,Integer> getMutableModelConfigsValue()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Integer> |
|
getName()
public 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 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 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. |
getObservabilityConfigBuilder()
public ObservabilityConfig.Builder getObservabilityConfigBuilder()Optional. Observability config for the engine.
.google.cloud.discoveryengine.v1beta.ObservabilityConfig observability_config = 39 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ObservabilityConfig.Builder |
|
getObservabilityConfigOrBuilder()
public 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 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The procurementContactEmails at the given index. |
getProcurementContactEmailsBytes(int index)
public 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the procurementContactEmails at the given index. |
getProcurementContactEmailsCount()
public 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 ProtocolStringList getProcurementContactEmailsList()Optional. The emails of the procurement contacts.
repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the procurementContactEmails. |
getSearchEngineConfig()
public 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. |
getSearchEngineConfigBuilder()
public Engine.SearchEngineConfig.Builder getSearchEngineConfigBuilder()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.Builder |
|
getSearchEngineConfigOrBuilder()
public 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 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 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 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
public 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 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 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 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 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAgentGatewaySetting(AgentGatewaySetting value)
public Engine.Builder mergeAgentGatewaySetting(AgentGatewaySetting value)Optional. The agent gateway setting for the engine.
.google.cloud.discoveryengine.v1beta.AgentGatewaySetting agent_gateway_setting = 43 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AgentGatewaySetting |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeChatEngineConfig(Engine.ChatEngineConfig value)
public Engine.Builder mergeChatEngineConfig(Engine.ChatEngineConfig value)Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.ChatEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeChatEngineMetadata(Engine.ChatEngineMetadata value)
public Engine.Builder mergeChatEngineMetadata(Engine.ChatEngineMetadata value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.ChatEngineMetadata |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeCmekConfig(CmekConfig value)
public Engine.Builder mergeCmekConfig(CmekConfig value)Output only. CMEK-related information for the Engine.
.google.cloud.discoveryengine.v1beta.CmekConfig cmek_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
CmekConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeCommonConfig(Engine.CommonConfig value)
public Engine.Builder mergeCommonConfig(Engine.CommonConfig value)Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.CommonConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeCreateTime(Timestamp value)
public Engine.Builder mergeCreateTime(Timestamp value)Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeFrom(Engine other)
public Engine.Builder mergeFrom(Engine other)| Parameter | |
|---|---|
| Name | Description |
other |
Engine |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Engine.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Engine.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeKnowledgeGraphConfig(Engine.KnowledgeGraphConfig value)
public Engine.Builder mergeKnowledgeGraphConfig(Engine.KnowledgeGraphConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.KnowledgeGraphConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeMediaRecommendationEngineConfig(Engine.MediaRecommendationEngineConfig value)
public Engine.Builder mergeMediaRecommendationEngineConfig(Engine.MediaRecommendationEngineConfig value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.MediaRecommendationEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeObservabilityConfig(ObservabilityConfig value)
public Engine.Builder mergeObservabilityConfig(ObservabilityConfig value)Optional. Observability config for the engine.
.google.cloud.discoveryengine.v1beta.ObservabilityConfig observability_config = 39 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ObservabilityConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeSearchEngineConfig(Engine.SearchEngineConfig value)
public Engine.Builder mergeSearchEngineConfig(Engine.SearchEngineConfig value)Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.SearchEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
mergeUpdateTime(Timestamp value)
public Engine.Builder mergeUpdateTime(Timestamp value)Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putAllConnectorTenantInfo(Map<String,String> values)
public Engine.Builder putAllConnectorTenantInfo(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putAllFeatures(Map<String,Engine.FeatureState> values)
public Engine.Builder putAllFeatures(Map<String,Engine.FeatureState> values)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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-product-intelligence
map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,FeatureState> |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putAllFeaturesValue(Map<String,Integer> values)
public Engine.Builder putAllFeaturesValue(Map<String,Integer> values)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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-product-intelligence
map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,Integer> |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putAllModelConfigs(Map<String,Engine.ModelState> values)
public Engine.Builder putAllModelConfigs(Map<String,Engine.ModelState> values)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 |
values |
Map<String,ModelState> |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putAllModelConfigsValue(Map<String,Integer> values)
public Engine.Builder putAllModelConfigsValue(Map<String,Integer> values)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 |
values |
Map<String,Integer> |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putConnectorTenantInfo(String key, String value)
public Engine.Builder putConnectorTenantInfo(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putFeatures(String key, Engine.FeatureState value)
public Engine.Builder putFeatures(String key, Engine.FeatureState value)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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-product-intelligence
map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
Engine.FeatureState |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putFeaturesValue(String key, int value)
public Engine.Builder putFeaturesValue(String key, int value)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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-product-intelligence
map<string, .google.cloud.discoveryengine.v1beta.Engine.FeatureState> features = 30 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
int |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putModelConfigs(String key, Engine.ModelState value)
public Engine.Builder putModelConfigs(String key, Engine.ModelState value)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 |
value |
Engine.ModelState |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
putModelConfigsValue(String key, int value)
public Engine.Builder putModelConfigsValue(String key, int value)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 |
value |
int |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
removeConnectorTenantInfo(String key)
public Engine.Builder removeConnectorTenantInfo(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 |
Engine.Builder |
|
removeFeatures(String key)
public Engine.Builder removeFeatures(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-galleryno-code-agent-builderprompt-gallerymodel-selectornotebook-lmpeople-searchpeople-search-org-chartbi-directional-audiofeedbacksession-sharingpersonalization-memorypersonalization-suggested-highlightsmobile-app-accessdisable-agent-sharingdisable-image-generationdisable-video-generationdisable-onedrive-uploaddisable-talk-to-contentdisable-google-drive-uploaddisable-welcome-emailsdisable-canvasdisable-canvas-workspacedisable-skillsenable-end-user-sharing-with-groupssingle-agent-orchestrationmulti-agent-orchestrationcross-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.Builder |
|
removeModelConfigs(String key)
public Engine.Builder removeModelConfigs(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.Builder |
|
setAgentGatewaySetting(AgentGatewaySetting value)
public Engine.Builder setAgentGatewaySetting(AgentGatewaySetting value)Optional. The agent gateway setting for the engine.
.google.cloud.discoveryengine.v1beta.AgentGatewaySetting agent_gateway_setting = 43 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AgentGatewaySetting |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setAgentGatewaySetting(AgentGatewaySetting.Builder builderForValue)
public Engine.Builder setAgentGatewaySetting(AgentGatewaySetting.Builder builderForValue)Optional. The agent gateway setting for the engine.
.google.cloud.discoveryengine.v1beta.AgentGatewaySetting agent_gateway_setting = 43 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AgentGatewaySetting.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setAppType(Engine.AppType value)
public Engine.Builder setAppType(Engine.AppType value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.AppTypeThe appType to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setAppTypeValue(int value)
public Engine.Builder setAppTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for appType to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setChatEngineConfig(Engine.ChatEngineConfig value)
public Engine.Builder setChatEngineConfig(Engine.ChatEngineConfig value)Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.ChatEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setChatEngineConfig(Engine.ChatEngineConfig.Builder builderForValue)
public Engine.Builder setChatEngineConfig(Engine.ChatEngineConfig.Builder builderForValue)Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
.google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.ChatEngineConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setChatEngineMetadata(Engine.ChatEngineMetadata value)
public Engine.Builder setChatEngineMetadata(Engine.ChatEngineMetadata value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.ChatEngineMetadata |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setChatEngineMetadata(Engine.ChatEngineMetadata.Builder builderForValue)
public Engine.Builder setChatEngineMetadata(Engine.ChatEngineMetadata.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.ChatEngineMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setCmekConfig(CmekConfig value)
public Engine.Builder setCmekConfig(CmekConfig value)Output only. CMEK-related information for the Engine.
.google.cloud.discoveryengine.v1beta.CmekConfig cmek_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
CmekConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setCmekConfig(CmekConfig.Builder builderForValue)
public Engine.Builder setCmekConfig(CmekConfig.Builder builderForValue)Output only. CMEK-related information for the Engine.
.google.cloud.discoveryengine.v1beta.CmekConfig cmek_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CmekConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setCommonConfig(Engine.CommonConfig value)
public Engine.Builder setCommonConfig(Engine.CommonConfig value)Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.CommonConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setCommonConfig(Engine.CommonConfig.Builder builderForValue)
public Engine.Builder setCommonConfig(Engine.CommonConfig.Builder builderForValue)Common config spec that specifies the metadata of the engine.
.google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.CommonConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setConfigurableBillingApproach(Engine.ConfigurableBillingApproach value)
public Engine.Builder setConfigurableBillingApproach(Engine.ConfigurableBillingApproach value)Optional. Configuration for configurable billing approach.
.google.cloud.discoveryengine.v1beta.Engine.ConfigurableBillingApproach configurable_billing_approach = 36 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.ConfigurableBillingApproachThe configurableBillingApproach to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setConfigurableBillingApproachValue(int value)
public Engine.Builder setConfigurableBillingApproachValue(int value)Optional. Configuration for configurable billing approach.
.google.cloud.discoveryengine.v1beta.Engine.ConfigurableBillingApproach configurable_billing_approach = 36 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for configurableBillingApproach to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public Engine.Builder setCreateTime(Timestamp value)Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Engine.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Timestamp the Recommendation Engine was created at.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setDataStoreIds(int index, String value)
public Engine.Builder setDataStoreIds(int index, String value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe dataStoreIds to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setDisableAnalytics(boolean value)
public Engine.Builder setDisableAnalytics(boolean value)Optional. Whether to disable analytics for searches performed on this engine.
bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe disableAnalytics to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setDisplayName(String value)
public Engine.Builder setDisplayName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Engine.Builder setDisplayNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setIndustryVertical(IndustryVertical value)
public Engine.Builder setIndustryVertical(IndustryVertical value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
IndustryVerticalThe industryVertical to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setIndustryVerticalValue(int value)
public Engine.Builder setIndustryVerticalValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for industryVertical to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setKnowledgeGraphConfig(Engine.KnowledgeGraphConfig value)
public Engine.Builder setKnowledgeGraphConfig(Engine.KnowledgeGraphConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.KnowledgeGraphConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setKnowledgeGraphConfig(Engine.KnowledgeGraphConfig.Builder builderForValue)
public Engine.Builder setKnowledgeGraphConfig(Engine.KnowledgeGraphConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.KnowledgeGraphConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setMarketplaceAgentVisibility(Engine.MarketplaceAgentVisibility value)
public Engine.Builder setMarketplaceAgentVisibility(Engine.MarketplaceAgentVisibility value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.MarketplaceAgentVisibilityThe marketplaceAgentVisibility to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setMarketplaceAgentVisibilityValue(int value)
public Engine.Builder setMarketplaceAgentVisibilityValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for marketplaceAgentVisibility to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setMediaRecommendationEngineConfig(Engine.MediaRecommendationEngineConfig value)
public Engine.Builder setMediaRecommendationEngineConfig(Engine.MediaRecommendationEngineConfig value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.MediaRecommendationEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setMediaRecommendationEngineConfig(Engine.MediaRecommendationEngineConfig.Builder builderForValue)
public Engine.Builder setMediaRecommendationEngineConfig(Engine.MediaRecommendationEngineConfig.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.MediaRecommendationEngineConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setName(String value)
public Engine.Builder setName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Engine.Builder setNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setObservabilityConfig(ObservabilityConfig value)
public Engine.Builder setObservabilityConfig(ObservabilityConfig value)Optional. Observability config for the engine.
.google.cloud.discoveryengine.v1beta.ObservabilityConfig observability_config = 39 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ObservabilityConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setObservabilityConfig(ObservabilityConfig.Builder builderForValue)
public Engine.Builder setObservabilityConfig(ObservabilityConfig.Builder builderForValue)Optional. Observability config for the engine.
.google.cloud.discoveryengine.v1beta.ObservabilityConfig observability_config = 39 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ObservabilityConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setProcurementContactEmails(int index, String value)
public Engine.Builder setProcurementContactEmails(int index, String value)Optional. The emails of the procurement contacts.
repeated string procurement_contact_emails = 45 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe procurementContactEmails to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setSearchEngineConfig(Engine.SearchEngineConfig value)
public Engine.Builder setSearchEngineConfig(Engine.SearchEngineConfig value)Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.SearchEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setSearchEngineConfig(Engine.SearchEngineConfig.Builder builderForValue)
public Engine.Builder setSearchEngineConfig(Engine.SearchEngineConfig.Builder builderForValue)Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
.google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.SearchEngineConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setSolutionType(SolutionType value)
public Engine.Builder setSolutionType(SolutionType value)Required. The solutions of the engine.
.google.cloud.discoveryengine.v1beta.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
SolutionTypeThe solutionType to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setSolutionTypeValue(int value)
public Engine.Builder setSolutionTypeValue(int value)Required. The solutions of the engine.
.google.cloud.discoveryengine.v1beta.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for solutionType to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
This builder for chaining. |
setUpdateTime(Timestamp value)
public Engine.Builder setUpdateTime(Timestamp value)Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public Engine.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Timestamp the Recommendation Engine was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.Builder |
|