EngineArgs class

The set of arguments for Engine. The set of arguments for Engine.

Constructors

EngineArgs({Input<GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig>? chatEngineConfig, required Input<String> collectionId, Input<GoogleCloudDiscoveryengineV1alphaEngineCommonConfig>? commonConfig, Input<List<String>>? dataStoreIds, required Input<String> displayName, required Input<String> engineId, Input<EngineIndustryVertical>? industryVertical, Input<String>? location, Input<GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig>? mediaRecommendationEngineConfig, Input<String>? name, Input<String>? project, Input<GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig>? searchEngineConfig, Input<Map<String, dynamic>>? similarDocumentsConfig, required Input<EngineSolutionType> solutionType})
Creates a new EngineArgs. chatEngineConfig Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. collectionId Required. commonConfig Common config spec that specifies the metadata of the engine. dataStoreIds The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations. displayName The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. engineId Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. industryVertical The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine. location Optional. mediaRecommendationEngineConfig Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. name Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. project Optional. searchEngineConfig Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. similarDocumentsConfig Additional config specs for a similar-items engine. solutionType The solutions of the engine.
const
EngineArgs.fromMap(Map<String, dynamic> map)
factory

Properties

chatEngineConfig → Input<GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig>?
Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
final
collectionId → Input<String>
final
commonConfig → Input<GoogleCloudDiscoveryengineV1alphaEngineCommonConfig>?
Common config spec that specifies the metadata of the engine.
final
dataStoreIds → Input<List<String>>?
The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations.
final
displayName → Input<String>
The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
final
engineId → Input<String>
Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
final
hashCode → int
The hash code for this object.
no setterinherited
industryVertical → Input<EngineIndustryVertical>?
The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
final
location → Input<String>?
final
mediaRecommendationEngineConfig → Input<GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig>?
Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
final
name → Input<String>?
Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
final
project → Input<String>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchEngineConfig → Input<GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig>?
Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
final
similarDocumentsConfig → Input<Map<String, dynamic>>?
Additional config specs for a similar-items engine.
final
solutionType → Input<EngineSolutionType>
The solutions of the engine.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited