GetEngineResult class

Result data returned by getEngine.

Constructors

GetEngineResult({required GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse chatEngineConfig, required GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse chatEngineMetadata, required GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse commonConfig, required String createTime, required List<String> dataStoreIds, required String displayName, required String industryVertical, required GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse mediaRecommendationEngineConfig, required String name, required GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse recommendationMetadata, required GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse searchEngineConfig, required Map<String, dynamic> similarDocumentsConfig, required String solutionType, required String updateTime})
Creates a new GetEngineResult. chatEngineConfig Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. chatEngineMetadata Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. commonConfig Common config spec that specifies the metadata of the engine. createTime Timestamp the Recommendation Engine was created at. 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. 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. 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. recommendationMetadata Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. 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. updateTime Timestamp the Recommendation Engine was last updated.
const
GetEngineResult.fromMap(Map<String, dynamic> map)
factory

Properties

chatEngineConfig → GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigResponse
Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
final
chatEngineMetadata → GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadataResponse
Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
final
commonConfig → GoogleCloudDiscoveryengineV1alphaEngineCommonConfigResponse
Common config spec that specifies the metadata of the engine.
final
createTime → String
Timestamp the Recommendation Engine was created at.
final
dataStoreIds → 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 → String
The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
final
hashCode → int
The hash code for this object.
no setterinherited
industryVertical → String
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
mediaRecommendationEngineConfig → GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigResponse
Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
final
name → 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
recommendationMetadata → GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadataResponse
Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchEngineConfig → GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfigResponse
Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
final
similarDocumentsConfig → Map<String, dynamic>
Additional config specs for a similar-items engine.
final
solutionType → String
The solutions of the engine.
final
updateTime → String
Timestamp the Recommendation Engine was last updated.
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