Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. discoveryengine
  5. SearchEngine
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.discoveryengine.SearchEngine

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

    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:

    Example Usage

    Discoveryengine Searchengine Basic

    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: {},
});

    import pulumi
import pulumi_gcp as gcp

basic = gcp.discoveryengine.DataStore("basic",
    location="global",
    data_store_id="example-datastore-id",
    display_name="tf-test-structured-datastore",
    industry_vertical="GENERIC",
    content_config="NO_CONTENT",
    solution_types=["SOLUTION_TYPE_SEARCH"],
    create_advanced_site_search=False)
basic_search_engine = gcp.discoveryengine.SearchEngine("basic",
    engine_id="example-engine-id",
    collection_id="default_collection",
    location=basic.location,
    display_name="Example Display Name",
    data_store_ids=[basic.data_store_id],
    search_engine_config={})

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/discoveryengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basic, err := discoveryengine.NewDataStore(ctx, "basic", &discoveryengine.DataStoreArgs{
			Location:         pulumi.String("global"),
			DataStoreId:      pulumi.String("example-datastore-id"),
			DisplayName:      pulumi.String("tf-test-structured-datastore"),
			IndustryVertical: pulumi.String("GENERIC"),
			ContentConfig:    pulumi.String("NO_CONTENT"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_SEARCH"),
			},
			CreateAdvancedSiteSearch: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = discoveryengine.NewSearchEngine(ctx, "basic", &discoveryengine.SearchEngineArgs{
			EngineId:     pulumi.String("example-engine-id"),
			CollectionId: pulumi.String("default_collection"),
			Location:     basic.Location,
			DisplayName:  pulumi.String("Example Display Name"),
			DataStoreIds: pulumi.StringArray{
				basic.DataStoreId,
			},
			SearchEngineConfig: &discoveryengine.SearchEngineSearchEngineConfigArgs{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var basic = new Gcp.DiscoveryEngine.DataStore("basic", new()
    {
        Location = "global",
        DataStoreId = "example-datastore-id",
        DisplayName = "tf-test-structured-datastore",
        IndustryVertical = "GENERIC",
        ContentConfig = "NO_CONTENT",
        SolutionTypes = new[]
        {
            "SOLUTION_TYPE_SEARCH",
        },
        CreateAdvancedSiteSearch = false,
    });

    var basicSearchEngine = new Gcp.DiscoveryEngine.SearchEngine("basic", new()
    {
        EngineId = "example-engine-id",
        CollectionId = "default_collection",
        Location = basic.Location,
        DisplayName = "Example Display Name",
        DataStoreIds = new[]
        {
            basic.DataStoreId,
        },
        SearchEngineConfig = null,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.discoveryengine.DataStore;
import com.pulumi.gcp.discoveryengine.DataStoreArgs;
import com.pulumi.gcp.discoveryengine.SearchEngine;
import com.pulumi.gcp.discoveryengine.SearchEngineArgs;
import com.pulumi.gcp.discoveryengine.inputs.SearchEngineSearchEngineConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var basic = new DataStore("basic", DataStoreArgs.builder()
            .location("global")
            .dataStoreId("example-datastore-id")
            .displayName("tf-test-structured-datastore")
            .industryVertical("GENERIC")
            .contentConfig("NO_CONTENT")
            .solutionTypes("SOLUTION_TYPE_SEARCH")
            .createAdvancedSiteSearch(false)
            .build());

        var basicSearchEngine = new SearchEngine("basicSearchEngine", SearchEngineArgs.builder()
            .engineId("example-engine-id")
            .collectionId("default_collection")
            .location(basic.location())
            .displayName("Example Display Name")
            .dataStoreIds(basic.dataStoreId())
            .searchEngineConfig()
            .build());

    }
}

    resources:
  basic:
    type: gcp:discoveryengine:DataStore
    properties:
      location: global
      dataStoreId: example-datastore-id
      displayName: tf-test-structured-datastore
      industryVertical: GENERIC
      contentConfig: NO_CONTENT
      solutionTypes:
        - SOLUTION_TYPE_SEARCH
      createAdvancedSiteSearch: false
  basicSearchEngine:
    type: gcp:discoveryengine:SearchEngine
    name: basic
    properties:
      engineId: example-engine-id
      collectionId: default_collection
      location: ${basic.location}
      displayName: Example Display Name
      dataStoreIds:
        - ${basic.dataStoreId}
      searchEngineConfig: {}

    Create SearchEngine Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SearchEngine(name: string, args: SearchEngineArgs, opts?: CustomResourceOptions);
    @overload
def SearchEngine(resource_name: str,
                 args: SearchEngineArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def SearchEngine(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 collection_id: Optional[str] = None,
                 data_store_ids: Optional[Sequence[str]] = None,
                 display_name: Optional[str] = None,
                 engine_id: Optional[str] = None,
                 location: Optional[str] = None,
                 search_engine_config: Optional[SearchEngineSearchEngineConfigArgs] = None,
                 common_config: Optional[SearchEngineCommonConfigArgs] = None,
                 industry_vertical: Optional[str] = None,
                 project: Optional[str] = None)
    func NewSearchEngine(ctx *Context, name string, args SearchEngineArgs, opts ...ResourceOption) (*SearchEngine, error)
    public SearchEngine(string name, SearchEngineArgs args, CustomResourceOptions? opts = null)
    public SearchEngine(String name, SearchEngineArgs args)
public SearchEngine(String name, SearchEngineArgs args, CustomResourceOptions options)

    type: gcp:discoveryengine:SearchEngine
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SearchEngineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SearchEngineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SearchEngineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SearchEngineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SearchEngineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var searchEngineResource = new Gcp.DiscoveryEngine.SearchEngine("searchEngineResource", new()
{
    CollectionId = "string",
    DataStoreIds = new[]
    {
        "string",
    },
    DisplayName = "string",
    EngineId = "string",
    Location = "string",
    SearchEngineConfig = new Gcp.DiscoveryEngine.Inputs.SearchEngineSearchEngineConfigArgs
    {
        SearchAddOns = new[]
        {
            "string",
        },
        SearchTier = "string",
    },
    CommonConfig = new Gcp.DiscoveryEngine.Inputs.SearchEngineCommonConfigArgs
    {
        CompanyName = "string",
    },
    IndustryVertical = "string",
    Project = "string",
});

    example, err := discoveryengine.NewSearchEngine(ctx, "searchEngineResource", &discoveryengine.SearchEngineArgs{
	CollectionId: pulumi.String("string"),
	DataStoreIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	EngineId:    pulumi.String("string"),
	Location:    pulumi.String("string"),
	SearchEngineConfig: &discoveryengine.SearchEngineSearchEngineConfigArgs{
		SearchAddOns: pulumi.StringArray{
			pulumi.String("string"),
		},
		SearchTier: pulumi.String("string"),
	},
	CommonConfig: &discoveryengine.SearchEngineCommonConfigArgs{
		CompanyName: pulumi.String("string"),
	},
	IndustryVertical: pulumi.String("string"),
	Project:          pulumi.String("string"),
})

    var searchEngineResource = new SearchEngine("searchEngineResource", SearchEngineArgs.builder()
    .collectionId("string")
    .dataStoreIds("string")
    .displayName("string")
    .engineId("string")
    .location("string")
    .searchEngineConfig(SearchEngineSearchEngineConfigArgs.builder()
        .searchAddOns("string")
        .searchTier("string")
        .build())
    .commonConfig(SearchEngineCommonConfigArgs.builder()
        .companyName("string")
        .build())
    .industryVertical("string")
    .project("string")
    .build());

    search_engine_resource = gcp.discoveryengine.SearchEngine("searchEngineResource",
    collection_id="string",
    data_store_ids=["string"],
    display_name="string",
    engine_id="string",
    location="string",
    search_engine_config={
        "search_add_ons": ["string"],
        "search_tier": "string",
    },
    common_config={
        "company_name": "string",
    },
    industry_vertical="string",
    project="string")

    const searchEngineResource = new gcp.discoveryengine.SearchEngine("searchEngineResource", {
    collectionId: "string",
    dataStoreIds: ["string"],
    displayName: "string",
    engineId: "string",
    location: "string",
    searchEngineConfig: {
        searchAddOns: ["string"],
        searchTier: "string",
    },
    commonConfig: {
        companyName: "string",
    },
    industryVertical: "string",
    project: "string",
});

    type: gcp:discoveryengine:SearchEngine
properties:
    collectionId: string
    commonConfig:
        companyName: string
    dataStoreIds:
        - string
    displayName: string
    engineId: string
    industryVertical: string
    location: string
    project: string
    searchEngineConfig:
        searchAddOns:
            - string
        searchTier: string

    SearchEngine Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SearchEngine resource accepts the following input properties:

    CollectionId string
    The collection ID.
    DataStoreIds List<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.
    DisplayName string
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    Unique ID to use for Search Engine App.
    Location string
    Location.
    SearchEngineConfig SearchEngineSearchEngineConfig
    Configurations for a Search Engine. Structure is documented below.
    CommonConfig SearchEngineCommonConfig
    Common config spec that specifies the metadata of the engine.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    Project string
    CollectionId string
    The collection ID.
    DataStoreIds []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.
    DisplayName string
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    Unique ID to use for Search Engine App.
    Location string
    Location.
    SearchEngineConfig SearchEngineSearchEngineConfigArgs
    Configurations for a Search Engine. Structure is documented below.
    CommonConfig SearchEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    Project string
    collectionId String
    The collection ID.
    dataStoreIds List<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.
    displayName String
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    Unique ID to use for Search Engine App.
    location String
    Location.
    searchEngineConfig SearchEngineSearchEngineConfig
    Configurations for a Search Engine. Structure is documented below.
    commonConfig SearchEngineCommonConfig
    Common config spec that specifies the metadata of the engine.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    project String
    collectionId string
    The collection ID.
    dataStoreIds 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.
    displayName string
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId string
    Unique ID to use for Search Engine App.
    location string
    Location.
    searchEngineConfig SearchEngineSearchEngineConfig
    Configurations for a Search Engine. Structure is documented below.
    commonConfig SearchEngineCommonConfig
    Common config spec that specifies the metadata of the engine.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    project string
    collection_id str
    The collection ID.
    data_store_ids Sequence[str]
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH type of engines, they can only associate with at most one data store.
    display_name str
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engine_id str
    Unique ID to use for Search Engine App.
    location str
    Location.
    search_engine_config SearchEngineSearchEngineConfigArgs
    Configurations for a Search Engine. Structure is documented below.
    common_config SearchEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine.
    industry_vertical str
    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: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    project str
    collectionId String
    The collection ID.
    dataStoreIds List<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.
    displayName String
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    Unique ID to use for Search Engine App.
    location String
    Location.
    searchEngineConfig Property Map
    Configurations for a Search Engine. Structure is documented below.
    commonConfig Property Map
    Common config spec that specifies the metadata of the engine.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SearchEngine resource produces the following output properties:

    CreateTime string
    Timestamp the Engine was created at.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name 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.
    UpdateTime string
    Timestamp the Engine was last updated.
    CreateTime string
    Timestamp the Engine was created at.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name 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.
    UpdateTime string
    Timestamp the Engine was last updated.
    createTime String
    Timestamp the Engine was created at.
    id String
    The provider-assigned unique ID for this managed resource.
    name 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.
    updateTime String
    Timestamp the Engine was last updated.
    createTime string
    Timestamp the Engine was created at.
    id string
    The provider-assigned unique ID for this managed resource.
    name 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.
    updateTime string
    Timestamp the Engine was last updated.
    create_time str
    Timestamp the Engine was created at.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    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.
    update_time str
    Timestamp the Engine was last updated.
    createTime String
    Timestamp the Engine was created at.
    id String
    The provider-assigned unique ID for this managed resource.
    name 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.
    updateTime String
    Timestamp the Engine was last updated.

    Look up Existing SearchEngine Resource

    Get an existing SearchEngine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SearchEngineState, opts?: CustomResourceOptions): SearchEngine
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        collection_id: Optional[str] = None,
        common_config: Optional[SearchEngineCommonConfigArgs] = None,
        create_time: Optional[str] = None,
        data_store_ids: Optional[Sequence[str]] = None,
        display_name: Optional[str] = None,
        engine_id: Optional[str] = None,
        industry_vertical: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        search_engine_config: Optional[SearchEngineSearchEngineConfigArgs] = None,
        update_time: Optional[str] = None) -> SearchEngine
    func GetSearchEngine(ctx *Context, name string, id IDInput, state *SearchEngineState, opts ...ResourceOption) (*SearchEngine, error)
    public static SearchEngine Get(string name, Input<string> id, SearchEngineState? state, CustomResourceOptions? opts = null)
    public static SearchEngine get(String name, Output<String> id, SearchEngineState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CollectionId string
    The collection ID.
    CommonConfig SearchEngineCommonConfig
    Common config spec that specifies the metadata of the engine.
    CreateTime string
    Timestamp the Engine was created at.
    DataStoreIds List<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.
    DisplayName string
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    Unique ID to use for Search Engine App.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    Location string
    Location.
    Name 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.
    Project string
    SearchEngineConfig SearchEngineSearchEngineConfig
    Configurations for a Search Engine. Structure is documented below.
    UpdateTime string
    Timestamp the Engine was last updated.
    CollectionId string
    The collection ID.
    CommonConfig SearchEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine.
    CreateTime string
    Timestamp the Engine was created at.
    DataStoreIds []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.
    DisplayName string
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    EngineId string
    Unique ID to use for Search Engine App.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    Location string
    Location.
    Name 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.
    Project string
    SearchEngineConfig SearchEngineSearchEngineConfigArgs
    Configurations for a Search Engine. Structure is documented below.
    UpdateTime string
    Timestamp the Engine was last updated.
    collectionId String
    The collection ID.
    commonConfig SearchEngineCommonConfig
    Common config spec that specifies the metadata of the engine.
    createTime String
    Timestamp the Engine was created at.
    dataStoreIds List<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.
    displayName String
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    Unique ID to use for Search Engine App.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    location String
    Location.
    name 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.
    project String
    searchEngineConfig SearchEngineSearchEngineConfig
    Configurations for a Search Engine. Structure is documented below.
    updateTime String
    Timestamp the Engine was last updated.
    collectionId string
    The collection ID.
    commonConfig SearchEngineCommonConfig
    Common config spec that specifies the metadata of the engine.
    createTime string
    Timestamp the Engine was created at.
    dataStoreIds 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.
    displayName string
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId string
    Unique ID to use for Search Engine App.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    location string
    Location.
    name 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.
    project string
    searchEngineConfig SearchEngineSearchEngineConfig
    Configurations for a Search Engine. Structure is documented below.
    updateTime string
    Timestamp the Engine was last updated.
    collection_id str
    The collection ID.
    common_config SearchEngineCommonConfigArgs
    Common config spec that specifies the metadata of the engine.
    create_time str
    Timestamp the Engine was created at.
    data_store_ids Sequence[str]
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH type of engines, they can only associate with at most one data store.
    display_name str
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engine_id str
    Unique ID to use for Search Engine App.
    industry_vertical str
    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: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    location str
    Location.
    name str
    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.
    project str
    search_engine_config SearchEngineSearchEngineConfigArgs
    Configurations for a Search Engine. Structure is documented below.
    update_time str
    Timestamp the Engine was last updated.
    collectionId String
    The collection ID.
    commonConfig Property Map
    Common config spec that specifies the metadata of the engine.
    createTime String
    Timestamp the Engine was created at.
    dataStoreIds List<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.
    displayName String
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    engineId String
    Unique ID to use for Search Engine App.
    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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"]
    location String
    Location.
    name 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.
    project String
    searchEngineConfig Property Map
    Configurations for a Search Engine. Structure is documented below.
    updateTime String
    Timestamp the Engine was last updated.

    Supporting Types

    SearchEngineCommonConfig, SearchEngineCommonConfigArgs

    CompanyName string
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.cd
    CompanyName string
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.cd
    companyName String
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.cd
    companyName string
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.cd
    company_name str
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.cd
    companyName String
    The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.cd

    SearchEngineSearchEngineConfig, SearchEngineSearchEngineConfigArgs

    SearchAddOns List<string>
    The add-on that this search engine enables. Each value may be one of: SEARCH_ADD_ON_LLM.

    SearchTier string
    The search feature tier of this engine. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. Default value is SEARCH_TIER_STANDARD. Possible values are: SEARCH_TIER_STANDARD, SEARCH_TIER_ENTERPRISE.
    SearchAddOns []string
    The add-on that this search engine enables. Each value may be one of: SEARCH_ADD_ON_LLM.

    SearchTier string
    The search feature tier of this engine. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. Default value is SEARCH_TIER_STANDARD. Possible values are: SEARCH_TIER_STANDARD, SEARCH_TIER_ENTERPRISE.
    searchAddOns List<String>
    The add-on that this search engine enables. Each value may be one of: SEARCH_ADD_ON_LLM.

    searchTier String
    The search feature tier of this engine. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. Default value is SEARCH_TIER_STANDARD. Possible values are: SEARCH_TIER_STANDARD, SEARCH_TIER_ENTERPRISE.
    searchAddOns string[]
    The add-on that this search engine enables. Each value may be one of: SEARCH_ADD_ON_LLM.

    searchTier string
    The search feature tier of this engine. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. Default value is SEARCH_TIER_STANDARD. Possible values are: SEARCH_TIER_STANDARD, SEARCH_TIER_ENTERPRISE.
    search_add_ons Sequence[str]
    The add-on that this search engine enables. Each value may be one of: SEARCH_ADD_ON_LLM.

    search_tier str
    The search feature tier of this engine. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. Default value is SEARCH_TIER_STANDARD. Possible values are: SEARCH_TIER_STANDARD, SEARCH_TIER_ENTERPRISE.
    searchAddOns List<String>
    The add-on that this search engine enables. Each value may be one of: SEARCH_ADD_ON_LLM.

    searchTier String
    The search feature tier of this engine. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. Default value is SEARCH_TIER_STANDARD. Possible values are: SEARCH_TIER_STANDARD, SEARCH_TIER_ENTERPRISE.

    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:

    $ 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}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-gcp