@pulumi/gcp/discoveryengine/searchEngine.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Vertex AI Search and Conversation can be used to create a search engine or a chat application by connecting it with a datastore
 *
 * To get more information about SearchEngine, see:
 *
 * * [API documentation](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines)
 * * How-to Guides
 *     * [Create a Search Engine](https://cloud.google.com/generative-ai-app-builder/docs/create-engine-es)
 *
 * ## Example Usage
 *
 * ### Discoveryengine Searchengine Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const basic = new gcp.discoveryengine.DataStore("basic", {
 *     location: "global",
 *     dataStoreId: "example-datastore-id",
 *     displayName: "tf-test-structured-datastore",
 *     industryVertical: "GENERIC",
 *     contentConfig: "NO_CONTENT",
 *     solutionTypes: ["SOLUTION_TYPE_SEARCH"],
 *     createAdvancedSiteSearch: false,
 * });
 * const basicSearchEngine = new gcp.discoveryengine.SearchEngine("basic", {
 *     engineId: "example-engine-id",
 *     collectionId: "default_collection",
 *     location: basic.location,
 *     displayName: "Example Display Name",
 *     dataStoreIds: [basic.dataStoreId],
 *     searchEngineConfig: {},
 * });
 * ```
 * ### Discoveryengine Searchengine Agentspace Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const agentspaceBasic = new gcp.discoveryengine.DataStore("agentspace_basic", {
 *     location: "global",
 *     dataStoreId: "example-datastore-id",
 *     displayName: "tf-test-structured-datastore",
 *     industryVertical: "GENERIC",
 *     contentConfig: "NO_CONTENT",
 *     solutionTypes: ["SOLUTION_TYPE_SEARCH"],
 *     createAdvancedSiteSearch: false,
 * });
 * const agentspaceBasicSearchEngine = new gcp.discoveryengine.SearchEngine("agentspace_basic", {
 *     engineId: "example-engine-id",
 *     collectionId: "default_collection",
 *     location: agentspaceBasic.location,
 *     displayName: "tf-test-agentspace-search-engine",
 *     dataStoreIds: [agentspaceBasic.dataStoreId],
 *     industryVertical: "GENERIC",
 *     appType: "APP_TYPE_INTRANET",
 *     searchEngineConfig: {
 *         searchTier: "SEARCH_TIER_STANDARD",
 *         requiredSubscriptionTier: "SUBSCRIPTION_TIER_ENTERPRISE",
 *         searchAddOns: ["SEARCH_ADD_ON_LLM"],
 *     },
 *     features: {
 *         "agent-sharing-without-admin-approval": "FEATURE_STATE_ON",
 *         "disable-agent-sharing": "FEATURE_STATE_OFF",
 *     },
 *     knowledgeGraphConfig: {},
 * });
 * ```
 *
 * ## Import
 *
 * SearchEngine can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}`
 * * `{{project}}/{{location}}/{{collection_id}}/{{engine_id}}`
 * * `{{location}}/{{collection_id}}/{{engine_id}}`
 *
 * When using the `pulumi import` command, SearchEngine can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:discoveryengine/searchEngine:SearchEngine default projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}
 * $ pulumi import gcp:discoveryengine/searchEngine:SearchEngine default {{project}}/{{location}}/{{collection_id}}/{{engine_id}}
 * $ pulumi import gcp:discoveryengine/searchEngine:SearchEngine default {{location}}/{{collection_id}}/{{engine_id}}
 * ```
 */
export declare class SearchEngine extends pulumi.CustomResource {
    /**
     * Get an existing SearchEngine 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 state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SearchEngineState, opts?: pulumi.CustomResourceOptions): SearchEngine;
    /**
     * Returns true if the given object is an instance of SearchEngine.  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 SearchEngine;
    /**
     * This is the application type this engine resource represents.
     * The supported values: 'APP_TYPE_UNSPECIFIED', 'APP_TYPE_INTRANET'.
     */
    readonly appType: pulumi.Output<string | undefined>;
    /**
     * The collection ID.
     */
    readonly collectionId: pulumi.Output<string>;
    /**
     * Common config spec that specifies the metadata of the engine.
     * Structure is documented below.
     */
    readonly commonConfig: pulumi.Output<outputs.discoveryengine.SearchEngineCommonConfig | undefined>;
    /**
     * Timestamp the Engine was created at.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH type of engines, they can only associate with at most one data store.
     */
    readonly dataStoreIds: pulumi.Output<string[]>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * Whether to disable analytics for searches performed on this engine.
     */
    readonly disableAnalytics: pulumi.Output<boolean | undefined>;
    /**
     * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * Unique ID to use for Search Engine App.
     */
    readonly engineId: pulumi.Output<string>;
    /**
     * A map of the feature config for the engine to opt in or opt out of features.
     */
    readonly features: pulumi.Output<{
        [key: string]: 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.
     * Default value is `GENERIC`.
     * Possible values are: `GENERIC`, `MEDIA`, `HEALTHCARE_FHIR`.
     */
    readonly industryVertical: pulumi.Output<string | undefined>;
    /**
     * The KMS key to be used to protect this Engine at creation time.
     * Must be set for requests that need to comply with CMEK Org Policy
     * protections.
     * If this field is set and processed successfully, the Engine will be
     * protected by the KMS key, as indicated in the cmekConfig field.
     */
    readonly kmsKeyName: pulumi.Output<string | undefined>;
    /**
     * Configurations for the Knowledge Graph.
     * Structure is documented below.
     */
    readonly knowledgeGraphConfig: pulumi.Output<outputs.discoveryengine.SearchEngineKnowledgeGraphConfig>;
    /**
     * Location.
     */
    readonly location: pulumi.Output<string>;
    /**
     * The unique full resource name of the search engine. Values are of the format
     * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
     * This field must be a UTF-8 encoded string with a length limit of 1024
     * characters.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * Configurations for a Search Engine.
     * Structure is documented below.
     */
    readonly searchEngineConfig: pulumi.Output<outputs.discoveryengine.SearchEngineSearchEngineConfig>;
    /**
     * Timestamp the Engine was last updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a SearchEngine 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: SearchEngineArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering SearchEngine resources.
 */
export interface SearchEngineState {
    /**
     * This is the application type this engine resource represents.
     * The supported values: 'APP_TYPE_UNSPECIFIED', 'APP_TYPE_INTRANET'.
     */
    appType?: pulumi.Input<string | undefined>;
    /**
     * The collection ID.
     */
    collectionId?: pulumi.Input<string | undefined>;
    /**
     * Common config spec that specifies the metadata of the engine.
     * Structure is documented below.
     */
    commonConfig?: pulumi.Input<inputs.discoveryengine.SearchEngineCommonConfig | undefined>;
    /**
     * Timestamp the Engine was created at.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH type of engines, they can only associate with at most one data store.
     */
    dataStoreIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * Whether to disable analytics for searches performed on this engine.
     */
    disableAnalytics?: pulumi.Input<boolean | undefined>;
    /**
     * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * Unique ID to use for Search Engine App.
     */
    engineId?: pulumi.Input<string | undefined>;
    /**
     * A map of the feature config for the engine to opt in or opt out of features.
     */
    features?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * 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.
     * Default value is `GENERIC`.
     * Possible values are: `GENERIC`, `MEDIA`, `HEALTHCARE_FHIR`.
     */
    industryVertical?: pulumi.Input<string | undefined>;
    /**
     * The KMS key to be used to protect this Engine at creation time.
     * Must be set for requests that need to comply with CMEK Org Policy
     * protections.
     * If this field is set and processed successfully, the Engine will be
     * protected by the KMS key, as indicated in the cmekConfig field.
     */
    kmsKeyName?: pulumi.Input<string | undefined>;
    /**
     * Configurations for the Knowledge Graph.
     * Structure is documented below.
     */
    knowledgeGraphConfig?: pulumi.Input<inputs.discoveryengine.SearchEngineKnowledgeGraphConfig | undefined>;
    /**
     * Location.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The unique full resource name of the search engine. Values are of the format
     * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
     * This field must be a UTF-8 encoded string with a length limit of 1024
     * characters.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * Configurations for a Search Engine.
     * Structure is documented below.
     */
    searchEngineConfig?: pulumi.Input<inputs.discoveryengine.SearchEngineSearchEngineConfig | undefined>;
    /**
     * Timestamp the Engine was last updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a SearchEngine resource.
 */
export interface SearchEngineArgs {
    /**
     * This is the application type this engine resource represents.
     * The supported values: 'APP_TYPE_UNSPECIFIED', 'APP_TYPE_INTRANET'.
     */
    appType?: pulumi.Input<string | undefined>;
    /**
     * The collection ID.
     */
    collectionId: pulumi.Input<string>;
    /**
     * Common config spec that specifies the metadata of the engine.
     * Structure is documented below.
     */
    commonConfig?: pulumi.Input<inputs.discoveryengine.SearchEngineCommonConfig | undefined>;
    /**
     * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH type of engines, they can only associate with at most one data store.
     */
    dataStoreIds: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * Whether to disable analytics for searches performed on this engine.
     */
    disableAnalytics?: pulumi.Input<boolean | undefined>;
    /**
     * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
     */
    displayName: pulumi.Input<string>;
    /**
     * Unique ID to use for Search Engine App.
     */
    engineId: pulumi.Input<string>;
    /**
     * A map of the feature config for the engine to opt in or opt out of features.
     */
    features?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * 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.
     * Default value is `GENERIC`.
     * Possible values are: `GENERIC`, `MEDIA`, `HEALTHCARE_FHIR`.
     */
    industryVertical?: pulumi.Input<string | undefined>;
    /**
     * The KMS key to be used to protect this Engine at creation time.
     * Must be set for requests that need to comply with CMEK Org Policy
     * protections.
     * If this field is set and processed successfully, the Engine will be
     * protected by the KMS key, as indicated in the cmekConfig field.
     */
    kmsKeyName?: pulumi.Input<string | undefined>;
    /**
     * Configurations for the Knowledge Graph.
     * Structure is documented below.
     */
    knowledgeGraphConfig?: pulumi.Input<inputs.discoveryengine.SearchEngineKnowledgeGraphConfig | undefined>;
    /**
     * Location.
     */
    location: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * Configurations for a Search Engine.
     * Structure is documented below.
     */
    searchEngineConfig: pulumi.Input<inputs.discoveryengine.SearchEngineSearchEngineConfig>;
}
//# sourceMappingURL=searchEngine.d.ts.map