Class Engine (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public final class Engine extends GeneratedMessage implements EngineOrBuilder

Metadata that describes the training and serving parameters of an Engine.

Protobuf type google.cloud.discoveryengine.v1beta.Engine

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Engine

Implements

EngineOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AGENT_GATEWAY_SETTING_FIELD_NUMBER

public static final int AGENT_GATEWAY_SETTING_FIELD_NUMBER

Field Value
Type	Description
int

APP_TYPE_FIELD_NUMBER

public static final int APP_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

CHAT_ENGINE_CONFIG_FIELD_NUMBER

public static final int CHAT_ENGINE_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

CHAT_ENGINE_METADATA_FIELD_NUMBER

public static final int CHAT_ENGINE_METADATA_FIELD_NUMBER

Field Value
Type	Description
int

CMEK_CONFIG_FIELD_NUMBER

public static final int CMEK_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

COMMON_CONFIG_FIELD_NUMBER

public static final int COMMON_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

CONFIGURABLE_BILLING_APPROACH_FIELD_NUMBER

public static final int CONFIGURABLE_BILLING_APPROACH_FIELD_NUMBER

Field Value
Type	Description
int

CONNECTOR_TENANT_INFO_FIELD_NUMBER

public static final int CONNECTOR_TENANT_INFO_FIELD_NUMBER

Field Value
Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

DATA_STORE_IDS_FIELD_NUMBER

public static final int DATA_STORE_IDS_FIELD_NUMBER

Field Value
Type	Description
int

DISABLE_ANALYTICS_FIELD_NUMBER

public static final int DISABLE_ANALYTICS_FIELD_NUMBER

Field Value
Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER

Field Value
Type	Description
int

INDUSTRY_VERTICAL_FIELD_NUMBER

public static final int INDUSTRY_VERTICAL_FIELD_NUMBER

Field Value
Type	Description
int

KNOWLEDGE_GRAPH_CONFIG_FIELD_NUMBER

public static final int KNOWLEDGE_GRAPH_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

MARKETPLACE_AGENT_VISIBILITY_FIELD_NUMBER

public static final int MARKETPLACE_AGENT_VISIBILITY_FIELD_NUMBER

Field Value
Type	Description
int

MEDIA_RECOMMENDATION_ENGINE_CONFIG_FIELD_NUMBER

public static final int MEDIA_RECOMMENDATION_ENGINE_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

MODEL_CONFIGS_FIELD_NUMBER

public static final int MODEL_CONFIGS_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

OBSERVABILITY_CONFIG_FIELD_NUMBER

public static final int OBSERVABILITY_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

PROCUREMENT_CONTACT_EMAILS_FIELD_NUMBER

public static final int PROCUREMENT_CONTACT_EMAILS_FIELD_NUMBER

Field Value
Type	Description
int

SEARCH_ENGINE_CONFIG_FIELD_NUMBER

public static final int SEARCH_ENGINE_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

SOLUTION_TYPE_FIELD_NUMBER

public static final int SOLUTION_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Engine getDefaultInstance()

Returns
Type	Description
Engine

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Engine.Builder newBuilder()

Returns
Type	Description
Engine.Builder

newBuilder(Engine prototype)

public static Engine.Builder newBuilder(Engine prototype)

Parameter
Name	Description
prototype	Engine

Returns
Type	Description
Engine.Builder

parseDelimitedFrom(InputStream input)

public static Engine parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Engine

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Engine

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Engine parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Engine

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Engine

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Engine parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Engine

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Engine

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Engine parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Engine

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Engine

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Engine parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Engine

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Engine

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Engine parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Engine

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Engine parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Engine

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Engine> parser()

Returns
Type	Description
Parser<Engine>

Methods

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-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsModelConfigs(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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.

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.

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.

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.

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.

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.

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	int The 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	int The 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

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-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

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

Returns
Type	Description
int

getFeaturesMap()

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

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

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

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

Returns
Type	Description
Map<String,FeatureState>

getFeaturesOrDefault(String key, Engine.FeatureState defaultValue)

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

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

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

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

Parameters
Name	Description
key	String
defaultValue	Engine.FeatureState

Returns
Type	Description
Engine.FeatureState

getFeaturesOrThrow(String key)

public Engine.FeatureState getFeaturesOrThrow(String key)

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

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

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

Parameter
Name	Description
key	String

Returns
Type	Description
Engine.FeatureState

getFeaturesValue() (deprecated)

public 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-gallery
• no-code-agent-builder
• prompt-gallery
• model-selector
• notebook-lm
• people-search
• people-search-org-chart
• bi-directional-audio
• feedback
• session-sharing
• personalization-memory
• personalization-suggested-highlights
• mobile-app-access
• disable-agent-sharing
• disable-image-generation
• disable-video-generation
• disable-onedrive-upload
• disable-talk-to-content
• disable-google-drive-upload
• disable-welcome-emails
• disable-canvas
• disable-canvas-workspace
• disable-skills
• enable-end-user-sharing-with-groups
• single-agent-orchestration
• multi-agent-orchestration
• cross-product-intelligence

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

Returns
Type	Description
Map<String,Integer>

getFeaturesValueOrDefault(String key, int defaultValue)

public int getFeaturesValueOrDefault(String key, int defaultValue)

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

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

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

Parameters
Name	Description
key	String
defaultValue	int

Returns
Type	Description
int

getFeaturesValueOrThrow(String key)

public int getFeaturesValueOrThrow(String key)

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

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

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

Parameter
Name	Description
key	String

Returns
Type	Description
int

getIndustryVertical()

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

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.

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

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.

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

getParserForType()

public Parser<Engine> getParserForType()

Returns
Type	Description
Parser<Engine>

Overrides

GeneratedMessage.getParserForType()

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	int The 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	int The 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.

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Engine.Builder newBuilderForType()

Returns
Type	Description
Engine.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Engine.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Engine.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Engine.Builder toBuilder()

Returns
Type	Description
Engine.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException