import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../../types/input"; import * as outputs from "../../types/output"; import * as enums from "../../types/enums"; /** * Creates a Engine. */ export declare class Engine extends pulumi.CustomResource { /** * Get an existing Engine resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Engine; /** * Returns true if the given object is an instance of Engine. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Engine; /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ readonly chatEngineConfig: pulumi.Output; /** * Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ readonly chatEngineMetadata: pulumi.Output; readonly collectionId: pulumi.Output; /** * Common config spec that specifies the metadata of the engine. */ readonly commonConfig: pulumi.Output; /** * Timestamp the Recommendation Engine was created at. */ readonly createTime: pulumi.Output; /** * 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. */ readonly dataStoreIds: pulumi.Output; /** * The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ readonly displayName: pulumi.Output; /** * 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](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ readonly engineId: pulumi.Output; /** * 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. */ readonly industryVertical: pulumi.Output; readonly location: pulumi.Output; /** * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */ readonly mediaRecommendationEngineConfig: pulumi.Output; /** * 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. */ readonly name: pulumi.Output; readonly project: pulumi.Output; /** * Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */ readonly recommendationMetadata: pulumi.Output; /** * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */ readonly searchEngineConfig: pulumi.Output; /** * Additional config specs for a `similar-items` engine. */ readonly similarDocumentsConfig: pulumi.Output; /** * The solutions of the engine. */ readonly solutionType: pulumi.Output; /** * Timestamp the Recommendation Engine was last updated. */ readonly updateTime: pulumi.Output; /** * Create a Engine resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: EngineArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Engine resource. */ export interface EngineArgs { /** * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ chatEngineConfig?: pulumi.Input; collectionId: pulumi.Input; /** * Common config spec that specifies the metadata of the engine. */ commonConfig?: pulumi.Input; /** * 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. */ dataStoreIds?: pulumi.Input[]>; /** * The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ displayName: pulumi.Input; /** * 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](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ engineId: pulumi.Input; /** * 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. */ industryVertical?: pulumi.Input; location?: pulumi.Input; /** * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */ mediaRecommendationEngineConfig?: pulumi.Input; /** * 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. */ name?: pulumi.Input; project?: pulumi.Input; /** * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */ searchEngineConfig?: pulumi.Input; /** * Additional config specs for a `similar-items` engine. */ similarDocumentsConfig?: pulumi.Input; /** * The solutions of the engine. */ solutionType: pulumi.Input; }