discoveryengine

package
v7.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 27, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChatEngine added in v7.8.0 

type ChatEngine struct {
	pulumi.CustomResourceState

	// Configurations for a chat Engine.
	// Structure is documented below.
	ChatEngineConfig ChatEngineChatEngineConfigOutput `pulumi:"chatEngineConfig"`
	// Additional information of the Chat Engine.
	// Structure is documented below.
	ChatEngineMetadatas ChatEngineChatEngineMetadataArrayOutput `pulumi:"chatEngineMetadatas"`
	// The collection ID.
	CollectionId pulumi.StringOutput `pulumi:"collectionId"`
	// Common config spec that specifies the metadata of the engine.
	// Structure is documented below.
	CommonConfig ChatEngineCommonConfigPtrOutput `pulumi:"commonConfig"`
	// Timestamp the Engine was created at.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be `SOLUTION_TYPE_CHAT`. Adding or removing data stores will force recreation.
	DataStoreIds pulumi.StringArrayOutput `pulumi:"dataStoreIds"`
	// The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The ID to use for chat engine.
	EngineId pulumi.StringOutput `pulumi:"engineId"`
	// The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine.
	// Default value is `GENERIC`.
	// Possible values are: `GENERIC`.
	IndustryVertical pulumi.StringPtrOutput `pulumi:"industryVertical"`
	// Location.
	Location pulumi.StringOutput `pulumi:"location"`
	// The unique full resource name of the chat 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.StringOutput `pulumi:"name"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// Timestamp the Engine was last updated.
	UpdateTime pulumi.StringOutput `pulumi:"updateTime"`
}

Vertex chat and Conversation Engine Chat type

To get more information about ChatEngine, see:

* [API documentation](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines) * How-to Guides

## Example Usage ### Discoveryengine Chat Engine Basic

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/discoveryengine"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testDataStore, err := discoveryengine.NewDataStore(ctx, "testDataStore", &discoveryengine.DataStoreArgs{
			Location:         pulumi.String("global"),
			DataStoreId:      pulumi.String("data-store"),
			DisplayName:      pulumi.String("Structured datastore"),
			IndustryVertical: pulumi.String("GENERIC"),
			ContentConfig:    pulumi.String("NO_CONTENT"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_CHAT"),
			},
		})
		if err != nil {
			return err
		}
		testDataStore2, err := discoveryengine.NewDataStore(ctx, "testDataStore2", &discoveryengine.DataStoreArgs{
			Location:         testDataStore.Location,
			DataStoreId:      pulumi.String("data-store-2"),
			DisplayName:      pulumi.String("Structured datastore 2"),
			IndustryVertical: pulumi.String("GENERIC"),
			ContentConfig:    pulumi.String("NO_CONTENT"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_CHAT"),
			},
		})
		if err != nil {
			return err
		}
		_, err = discoveryengine.NewChatEngine(ctx, "primary", &discoveryengine.ChatEngineArgs{
			EngineId:         pulumi.String("chat-engine-id"),
			CollectionId:     pulumi.String("default_collection"),
			Location:         testDataStore.Location,
			DisplayName:      pulumi.String("Chat engine"),
			IndustryVertical: pulumi.String("GENERIC"),
			DataStoreIds: pulumi.StringArray{
				testDataStore.DataStoreId,
				testDataStore2.DataStoreId,
			},
			CommonConfig: &discoveryengine.ChatEngineCommonConfigArgs{
				CompanyName: pulumi.String("test-company"),
			},
			ChatEngineConfig: &discoveryengine.ChatEngineChatEngineConfigArgs{
				AgentCreationConfig: &discoveryengine.ChatEngineChatEngineConfigAgentCreationConfigArgs{
					Business:            pulumi.String("test business name"),
					DefaultLanguageCode: pulumi.String("en"),
					TimeZone:            pulumi.String("America/Los_Angeles"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

ChatEngine 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, ChatEngine can be imported using one of the formats above. For example:

```sh $ pulumi import gcp:discoveryengine/chatEngine:ChatEngine default projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}} ```

```sh $ pulumi import gcp:discoveryengine/chatEngine:ChatEngine default {{project}}/{{location}}/{{collection_id}}/{{engine_id}} ```

```sh $ pulumi import gcp:discoveryengine/chatEngine:ChatEngine default {{location}}/{{collection_id}}/{{engine_id}} ```

func GetChatEngine added in v7.8.0 

func GetChatEngine(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ChatEngineState, opts ...pulumi.ResourceOption) (*ChatEngine, error)

GetChatEngine gets an existing ChatEngine resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewChatEngine added in v7.8.0 

func NewChatEngine(ctx *pulumi.Context,
	name string, args *ChatEngineArgs, opts ...pulumi.ResourceOption) (*ChatEngine, error)

NewChatEngine registers a new resource with the given unique name, arguments, and options.

func (*ChatEngine) ElementType added in v7.8.0 

func (*ChatEngine) ElementType() reflect.Type

func (*ChatEngine) ToChatEngineOutput added in v7.8.0 

func (i *ChatEngine) ToChatEngineOutput() ChatEngineOutput

func (*ChatEngine) ToChatEngineOutputWithContext added in v7.8.0 

func (i *ChatEngine) ToChatEngineOutputWithContext(ctx context.Context) ChatEngineOutput

type ChatEngineArgs added in v7.8.0 

type ChatEngineArgs struct {
	// Configurations for a chat Engine.
	// Structure is documented below.
	ChatEngineConfig ChatEngineChatEngineConfigInput
	// The collection ID.
	CollectionId pulumi.StringInput
	// Common config spec that specifies the metadata of the engine.
	// Structure is documented below.
	CommonConfig ChatEngineCommonConfigPtrInput
	// The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be `SOLUTION_TYPE_CHAT`. Adding or removing data stores will force recreation.
	DataStoreIds pulumi.StringArrayInput
	// The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
	DisplayName pulumi.StringInput
	// The ID to use for chat engine.
	EngineId pulumi.StringInput
	// The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine.
	// Default value is `GENERIC`.
	// Possible values are: `GENERIC`.
	IndustryVertical pulumi.StringPtrInput
	// Location.
	Location pulumi.StringInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
}

The set of arguments for constructing a ChatEngine resource.

func (ChatEngineArgs) ElementType added in v7.8.0 

func (ChatEngineArgs) ElementType() reflect.Type

type ChatEngineArray added in v7.8.0 

type ChatEngineArray []ChatEngineInput

func (ChatEngineArray) ElementType added in v7.8.0 

func (ChatEngineArray) ElementType() reflect.Type

func (ChatEngineArray) ToChatEngineArrayOutput added in v7.8.0 

func (i ChatEngineArray) ToChatEngineArrayOutput() ChatEngineArrayOutput

func (ChatEngineArray) ToChatEngineArrayOutputWithContext added in v7.8.0 

func (i ChatEngineArray) ToChatEngineArrayOutputWithContext(ctx context.Context) ChatEngineArrayOutput

type ChatEngineArrayInput added in v7.8.0 

type ChatEngineArrayInput interface {
	pulumi.Input

	ToChatEngineArrayOutput() ChatEngineArrayOutput
	ToChatEngineArrayOutputWithContext(context.Context) ChatEngineArrayOutput
}

ChatEngineArrayInput is an input type that accepts ChatEngineArray and ChatEngineArrayOutput values. You can construct a concrete instance of `ChatEngineArrayInput` via: 

ChatEngineArray{ ChatEngineArgs{...} }

type ChatEngineArrayOutput added in v7.8.0 

type ChatEngineArrayOutput struct{ *pulumi.OutputState }

func (ChatEngineArrayOutput) ElementType added in v7.8.0 

func (ChatEngineArrayOutput) ElementType() reflect.Type

func (ChatEngineArrayOutput) Index added in v7.8.0 

func (o ChatEngineArrayOutput) Index(i pulumi.IntInput) ChatEngineOutput

func (ChatEngineArrayOutput) ToChatEngineArrayOutput added in v7.8.0 

func (o ChatEngineArrayOutput) ToChatEngineArrayOutput() ChatEngineArrayOutput

func (ChatEngineArrayOutput) ToChatEngineArrayOutputWithContext added in v7.8.0 

func (o ChatEngineArrayOutput) ToChatEngineArrayOutputWithContext(ctx context.Context) ChatEngineArrayOutput

type ChatEngineChatEngineConfig added in v7.8.0 

type ChatEngineChatEngineConfig struct {
	// The configuration to generate the Dialogflow agent that is associated to this Engine.
	// Structure is documented below.
	AgentCreationConfig ChatEngineChatEngineConfigAgentCreationConfig `pulumi:"agentCreationConfig"`
}

type ChatEngineChatEngineConfigAgentCreationConfig added in v7.8.0 

type ChatEngineChatEngineConfigAgentCreationConfig struct {
	// Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
	Business *string `pulumi:"business"`
	// The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
	DefaultLanguageCode string `pulumi:"defaultLanguageCode"`
	// Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.
	//
	// ***
	Location *string `pulumi:"location"`
	// The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
	TimeZone string `pulumi:"timeZone"`
}

type ChatEngineChatEngineConfigAgentCreationConfigArgs added in v7.8.0 

type ChatEngineChatEngineConfigAgentCreationConfigArgs struct {
	// Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
	Business pulumi.StringPtrInput `pulumi:"business"`
	// The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
	DefaultLanguageCode pulumi.StringInput `pulumi:"defaultLanguageCode"`
	// Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.
	//
	// ***
	Location pulumi.StringPtrInput `pulumi:"location"`
	// The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
	TimeZone pulumi.StringInput `pulumi:"timeZone"`
}

func (ChatEngineChatEngineConfigAgentCreationConfigArgs) ElementType added in v7.8.0 

func (ChatEngineChatEngineConfigAgentCreationConfigArgs) ElementType() reflect.Type

func (ChatEngineChatEngineConfigAgentCreationConfigArgs) ToChatEngineChatEngineConfigAgentCreationConfigOutput added in v7.8.0 

func (i ChatEngineChatEngineConfigAgentCreationConfigArgs) ToChatEngineChatEngineConfigAgentCreationConfigOutput() ChatEngineChatEngineConfigAgentCreationConfigOutput

func (ChatEngineChatEngineConfigAgentCreationConfigArgs) ToChatEngineChatEngineConfigAgentCreationConfigOutputWithContext added in v7.8.0 

func (i ChatEngineChatEngineConfigAgentCreationConfigArgs) ToChatEngineChatEngineConfigAgentCreationConfigOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigAgentCreationConfigOutput

func (ChatEngineChatEngineConfigAgentCreationConfigArgs) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutput added in v7.8.0 

func (i ChatEngineChatEngineConfigAgentCreationConfigArgs) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutput() ChatEngineChatEngineConfigAgentCreationConfigPtrOutput

func (ChatEngineChatEngineConfigAgentCreationConfigArgs) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutputWithContext added in v7.8.0 

func (i ChatEngineChatEngineConfigAgentCreationConfigArgs) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigAgentCreationConfigPtrOutput

type ChatEngineChatEngineConfigAgentCreationConfigInput added in v7.8.0 

type ChatEngineChatEngineConfigAgentCreationConfigInput interface {
	pulumi.Input

	ToChatEngineChatEngineConfigAgentCreationConfigOutput() ChatEngineChatEngineConfigAgentCreationConfigOutput
	ToChatEngineChatEngineConfigAgentCreationConfigOutputWithContext(context.Context) ChatEngineChatEngineConfigAgentCreationConfigOutput
}

ChatEngineChatEngineConfigAgentCreationConfigInput is an input type that accepts ChatEngineChatEngineConfigAgentCreationConfigArgs and ChatEngineChatEngineConfigAgentCreationConfigOutput values. You can construct a concrete instance of `ChatEngineChatEngineConfigAgentCreationConfigInput` via: 

ChatEngineChatEngineConfigAgentCreationConfigArgs{...}

type ChatEngineChatEngineConfigAgentCreationConfigOutput added in v7.8.0 

type ChatEngineChatEngineConfigAgentCreationConfigOutput struct{ *pulumi.OutputState }

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) Business added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigOutput) Business() pulumi.StringPtrOutput

Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) DefaultLanguageCode added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigOutput) DefaultLanguageCode() pulumi.StringOutput

The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) ElementType added in v7.8.0 

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) ElementType() reflect.Type

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) Location added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigOutput) Location() pulumi.StringPtrOutput

Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.

***

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) TimeZone added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigOutput) TimeZone() pulumi.StringOutput

The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) ToChatEngineChatEngineConfigAgentCreationConfigOutput added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigOutput) ToChatEngineChatEngineConfigAgentCreationConfigOutput() ChatEngineChatEngineConfigAgentCreationConfigOutput

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) ToChatEngineChatEngineConfigAgentCreationConfigOutputWithContext added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigOutput) ToChatEngineChatEngineConfigAgentCreationConfigOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigAgentCreationConfigOutput

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutput added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigOutput) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutput() ChatEngineChatEngineConfigAgentCreationConfigPtrOutput

func (ChatEngineChatEngineConfigAgentCreationConfigOutput) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutputWithContext added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigOutput) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigAgentCreationConfigPtrOutput

type ChatEngineChatEngineConfigAgentCreationConfigPtrInput added in v7.8.0 

type ChatEngineChatEngineConfigAgentCreationConfigPtrInput interface {
	pulumi.Input

	ToChatEngineChatEngineConfigAgentCreationConfigPtrOutput() ChatEngineChatEngineConfigAgentCreationConfigPtrOutput
	ToChatEngineChatEngineConfigAgentCreationConfigPtrOutputWithContext(context.Context) ChatEngineChatEngineConfigAgentCreationConfigPtrOutput
}

ChatEngineChatEngineConfigAgentCreationConfigPtrInput is an input type that accepts ChatEngineChatEngineConfigAgentCreationConfigArgs, ChatEngineChatEngineConfigAgentCreationConfigPtr and ChatEngineChatEngineConfigAgentCreationConfigPtrOutput values. You can construct a concrete instance of `ChatEngineChatEngineConfigAgentCreationConfigPtrInput` via: 

        ChatEngineChatEngineConfigAgentCreationConfigArgs{...}

or:

        nil

func ChatEngineChatEngineConfigAgentCreationConfigPtr added in v7.8.0 

func ChatEngineChatEngineConfigAgentCreationConfigPtr(v *ChatEngineChatEngineConfigAgentCreationConfigArgs) ChatEngineChatEngineConfigAgentCreationConfigPtrInput

type ChatEngineChatEngineConfigAgentCreationConfigPtrOutput added in v7.8.0 

type ChatEngineChatEngineConfigAgentCreationConfigPtrOutput struct{ *pulumi.OutputState }

func (ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) Business added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) Business() pulumi.StringPtrOutput

Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

func (ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) DefaultLanguageCode added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) DefaultLanguageCode() pulumi.StringPtrOutput

The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.

func (ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) Elem added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) Elem() ChatEngineChatEngineConfigAgentCreationConfigOutput

func (ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) ElementType added in v7.8.0 

func (ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) ElementType() reflect.Type

func (ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) Location added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) Location() pulumi.StringPtrOutput

Agent location for Agent creation, currently supported values: global/us/eu, it needs to be the same region as the Chat Engine.

***

func (ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) TimeZone added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) TimeZone() pulumi.StringPtrOutput

The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.

func (ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutput added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutput() ChatEngineChatEngineConfigAgentCreationConfigPtrOutput

func (ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutputWithContext added in v7.8.0 

func (o ChatEngineChatEngineConfigAgentCreationConfigPtrOutput) ToChatEngineChatEngineConfigAgentCreationConfigPtrOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigAgentCreationConfigPtrOutput

type ChatEngineChatEngineConfigArgs added in v7.8.0 

type ChatEngineChatEngineConfigArgs struct {
	// The configuration to generate the Dialogflow agent that is associated to this Engine.
	// Structure is documented below.
	AgentCreationConfig ChatEngineChatEngineConfigAgentCreationConfigInput `pulumi:"agentCreationConfig"`
}

func (ChatEngineChatEngineConfigArgs) ElementType added in v7.8.0 

func (ChatEngineChatEngineConfigArgs) ElementType() reflect.Type

func (ChatEngineChatEngineConfigArgs) ToChatEngineChatEngineConfigOutput added in v7.8.0 

func (i ChatEngineChatEngineConfigArgs) ToChatEngineChatEngineConfigOutput() ChatEngineChatEngineConfigOutput

func (ChatEngineChatEngineConfigArgs) ToChatEngineChatEngineConfigOutputWithContext added in v7.8.0 

func (i ChatEngineChatEngineConfigArgs) ToChatEngineChatEngineConfigOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigOutput

func (ChatEngineChatEngineConfigArgs) ToChatEngineChatEngineConfigPtrOutput added in v7.8.0 

func (i ChatEngineChatEngineConfigArgs) ToChatEngineChatEngineConfigPtrOutput() ChatEngineChatEngineConfigPtrOutput

func (ChatEngineChatEngineConfigArgs) ToChatEngineChatEngineConfigPtrOutputWithContext added in v7.8.0 

func (i ChatEngineChatEngineConfigArgs) ToChatEngineChatEngineConfigPtrOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigPtrOutput

type ChatEngineChatEngineConfigInput added in v7.8.0 

type ChatEngineChatEngineConfigInput interface {
	pulumi.Input

	ToChatEngineChatEngineConfigOutput() ChatEngineChatEngineConfigOutput
	ToChatEngineChatEngineConfigOutputWithContext(context.Context) ChatEngineChatEngineConfigOutput
}

ChatEngineChatEngineConfigInput is an input type that accepts ChatEngineChatEngineConfigArgs and ChatEngineChatEngineConfigOutput values. You can construct a concrete instance of `ChatEngineChatEngineConfigInput` via: 

ChatEngineChatEngineConfigArgs{...}

type ChatEngineChatEngineConfigOutput added in v7.8.0 

type ChatEngineChatEngineConfigOutput struct{ *pulumi.OutputState }

func (ChatEngineChatEngineConfigOutput) AgentCreationConfig added in v7.8.0 

func (o ChatEngineChatEngineConfigOutput) AgentCreationConfig() ChatEngineChatEngineConfigAgentCreationConfigOutput

The configuration to generate the Dialogflow agent that is associated to this Engine. Structure is documented below.

func (ChatEngineChatEngineConfigOutput) ElementType added in v7.8.0 

func (ChatEngineChatEngineConfigOutput) ElementType() reflect.Type

func (ChatEngineChatEngineConfigOutput) ToChatEngineChatEngineConfigOutput added in v7.8.0 

func (o ChatEngineChatEngineConfigOutput) ToChatEngineChatEngineConfigOutput() ChatEngineChatEngineConfigOutput

func (ChatEngineChatEngineConfigOutput) ToChatEngineChatEngineConfigOutputWithContext added in v7.8.0 

func (o ChatEngineChatEngineConfigOutput) ToChatEngineChatEngineConfigOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigOutput

func (ChatEngineChatEngineConfigOutput) ToChatEngineChatEngineConfigPtrOutput added in v7.8.0 

func (o ChatEngineChatEngineConfigOutput) ToChatEngineChatEngineConfigPtrOutput() ChatEngineChatEngineConfigPtrOutput

func (ChatEngineChatEngineConfigOutput) ToChatEngineChatEngineConfigPtrOutputWithContext added in v7.8.0 

func (o ChatEngineChatEngineConfigOutput) ToChatEngineChatEngineConfigPtrOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigPtrOutput

type ChatEngineChatEngineConfigPtrInput added in v7.8.0 

type ChatEngineChatEngineConfigPtrInput interface {
	pulumi.Input

	ToChatEngineChatEngineConfigPtrOutput() ChatEngineChatEngineConfigPtrOutput
	ToChatEngineChatEngineConfigPtrOutputWithContext(context.Context) ChatEngineChatEngineConfigPtrOutput
}

ChatEngineChatEngineConfigPtrInput is an input type that accepts ChatEngineChatEngineConfigArgs, ChatEngineChatEngineConfigPtr and ChatEngineChatEngineConfigPtrOutput values. You can construct a concrete instance of `ChatEngineChatEngineConfigPtrInput` via: 

        ChatEngineChatEngineConfigArgs{...}

or:

        nil

func ChatEngineChatEngineConfigPtr added in v7.8.0 

func ChatEngineChatEngineConfigPtr(v *ChatEngineChatEngineConfigArgs) ChatEngineChatEngineConfigPtrInput

type ChatEngineChatEngineConfigPtrOutput added in v7.8.0 

type ChatEngineChatEngineConfigPtrOutput struct{ *pulumi.OutputState }

func (ChatEngineChatEngineConfigPtrOutput) AgentCreationConfig added in v7.8.0 

func (o ChatEngineChatEngineConfigPtrOutput) AgentCreationConfig() ChatEngineChatEngineConfigAgentCreationConfigPtrOutput

The configuration to generate the Dialogflow agent that is associated to this Engine. Structure is documented below.

func (ChatEngineChatEngineConfigPtrOutput) Elem added in v7.8.0 

func (o ChatEngineChatEngineConfigPtrOutput) Elem() ChatEngineChatEngineConfigOutput

func (ChatEngineChatEngineConfigPtrOutput) ElementType added in v7.8.0 

func (ChatEngineChatEngineConfigPtrOutput) ElementType() reflect.Type

func (ChatEngineChatEngineConfigPtrOutput) ToChatEngineChatEngineConfigPtrOutput added in v7.8.0 

func (o ChatEngineChatEngineConfigPtrOutput) ToChatEngineChatEngineConfigPtrOutput() ChatEngineChatEngineConfigPtrOutput

func (ChatEngineChatEngineConfigPtrOutput) ToChatEngineChatEngineConfigPtrOutputWithContext added in v7.8.0 

func (o ChatEngineChatEngineConfigPtrOutput) ToChatEngineChatEngineConfigPtrOutputWithContext(ctx context.Context) ChatEngineChatEngineConfigPtrOutput

type ChatEngineChatEngineMetadata added in v7.8.0 

type ChatEngineChatEngineMetadata struct {
	// (Output)
	// The resource name of a Dialogflow agent, that this Chat Engine refers to.
	DialogflowAgent *string `pulumi:"dialogflowAgent"`
}

type ChatEngineChatEngineMetadataArgs added in v7.8.0 

type ChatEngineChatEngineMetadataArgs struct {
	// (Output)
	// The resource name of a Dialogflow agent, that this Chat Engine refers to.
	DialogflowAgent pulumi.StringPtrInput `pulumi:"dialogflowAgent"`
}

func (ChatEngineChatEngineMetadataArgs) ElementType added in v7.8.0 

func (ChatEngineChatEngineMetadataArgs) ElementType() reflect.Type

func (ChatEngineChatEngineMetadataArgs) ToChatEngineChatEngineMetadataOutput added in v7.8.0 

func (i ChatEngineChatEngineMetadataArgs) ToChatEngineChatEngineMetadataOutput() ChatEngineChatEngineMetadataOutput

func (ChatEngineChatEngineMetadataArgs) ToChatEngineChatEngineMetadataOutputWithContext added in v7.8.0 

func (i ChatEngineChatEngineMetadataArgs) ToChatEngineChatEngineMetadataOutputWithContext(ctx context.Context) ChatEngineChatEngineMetadataOutput

type ChatEngineChatEngineMetadataArray added in v7.8.0 

type ChatEngineChatEngineMetadataArray []ChatEngineChatEngineMetadataInput

func (ChatEngineChatEngineMetadataArray) ElementType added in v7.8.0 

func (ChatEngineChatEngineMetadataArray) ElementType() reflect.Type

func (ChatEngineChatEngineMetadataArray) ToChatEngineChatEngineMetadataArrayOutput added in v7.8.0 

func (i ChatEngineChatEngineMetadataArray) ToChatEngineChatEngineMetadataArrayOutput() ChatEngineChatEngineMetadataArrayOutput

func (ChatEngineChatEngineMetadataArray) ToChatEngineChatEngineMetadataArrayOutputWithContext added in v7.8.0 

func (i ChatEngineChatEngineMetadataArray) ToChatEngineChatEngineMetadataArrayOutputWithContext(ctx context.Context) ChatEngineChatEngineMetadataArrayOutput

type ChatEngineChatEngineMetadataArrayInput added in v7.8.0 

type ChatEngineChatEngineMetadataArrayInput interface {
	pulumi.Input

	ToChatEngineChatEngineMetadataArrayOutput() ChatEngineChatEngineMetadataArrayOutput
	ToChatEngineChatEngineMetadataArrayOutputWithContext(context.Context) ChatEngineChatEngineMetadataArrayOutput
}

ChatEngineChatEngineMetadataArrayInput is an input type that accepts ChatEngineChatEngineMetadataArray and ChatEngineChatEngineMetadataArrayOutput values. You can construct a concrete instance of `ChatEngineChatEngineMetadataArrayInput` via: 

ChatEngineChatEngineMetadataArray{ ChatEngineChatEngineMetadataArgs{...} }

type ChatEngineChatEngineMetadataArrayOutput added in v7.8.0 

type ChatEngineChatEngineMetadataArrayOutput struct{ *pulumi.OutputState }

func (ChatEngineChatEngineMetadataArrayOutput) ElementType added in v7.8.0 

func (ChatEngineChatEngineMetadataArrayOutput) ElementType() reflect.Type

func (ChatEngineChatEngineMetadataArrayOutput) Index added in v7.8.0 

func (o ChatEngineChatEngineMetadataArrayOutput) Index(i pulumi.IntInput) ChatEngineChatEngineMetadataOutput

func (ChatEngineChatEngineMetadataArrayOutput) ToChatEngineChatEngineMetadataArrayOutput added in v7.8.0 

func (o ChatEngineChatEngineMetadataArrayOutput) ToChatEngineChatEngineMetadataArrayOutput() ChatEngineChatEngineMetadataArrayOutput

func (ChatEngineChatEngineMetadataArrayOutput) ToChatEngineChatEngineMetadataArrayOutputWithContext added in v7.8.0 

func (o ChatEngineChatEngineMetadataArrayOutput) ToChatEngineChatEngineMetadataArrayOutputWithContext(ctx context.Context) ChatEngineChatEngineMetadataArrayOutput

type ChatEngineChatEngineMetadataInput added in v7.8.0 

type ChatEngineChatEngineMetadataInput interface {
	pulumi.Input

	ToChatEngineChatEngineMetadataOutput() ChatEngineChatEngineMetadataOutput
	ToChatEngineChatEngineMetadataOutputWithContext(context.Context) ChatEngineChatEngineMetadataOutput
}

ChatEngineChatEngineMetadataInput is an input type that accepts ChatEngineChatEngineMetadataArgs and ChatEngineChatEngineMetadataOutput values. You can construct a concrete instance of `ChatEngineChatEngineMetadataInput` via: 

ChatEngineChatEngineMetadataArgs{...}

type ChatEngineChatEngineMetadataOutput added in v7.8.0 

type ChatEngineChatEngineMetadataOutput struct{ *pulumi.OutputState }

func (ChatEngineChatEngineMetadataOutput) DialogflowAgent added in v7.8.0 

func (o ChatEngineChatEngineMetadataOutput) DialogflowAgent() pulumi.StringPtrOutput

(Output) The resource name of a Dialogflow agent, that this Chat Engine refers to.

func (ChatEngineChatEngineMetadataOutput) ElementType added in v7.8.0 

func (ChatEngineChatEngineMetadataOutput) ElementType() reflect.Type

func (ChatEngineChatEngineMetadataOutput) ToChatEngineChatEngineMetadataOutput added in v7.8.0 

func (o ChatEngineChatEngineMetadataOutput) ToChatEngineChatEngineMetadataOutput() ChatEngineChatEngineMetadataOutput

func (ChatEngineChatEngineMetadataOutput) ToChatEngineChatEngineMetadataOutputWithContext added in v7.8.0 

func (o ChatEngineChatEngineMetadataOutput) ToChatEngineChatEngineMetadataOutputWithContext(ctx context.Context) ChatEngineChatEngineMetadataOutput

type ChatEngineCommonConfig added in v7.8.0 

type ChatEngineCommonConfig struct {
	// The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
	CompanyName *string `pulumi:"companyName"`
}

type ChatEngineCommonConfigArgs added in v7.8.0 

type ChatEngineCommonConfigArgs struct {
	// The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
	CompanyName pulumi.StringPtrInput `pulumi:"companyName"`
}

func (ChatEngineCommonConfigArgs) ElementType added in v7.8.0 

func (ChatEngineCommonConfigArgs) ElementType() reflect.Type

func (ChatEngineCommonConfigArgs) ToChatEngineCommonConfigOutput added in v7.8.0 

func (i ChatEngineCommonConfigArgs) ToChatEngineCommonConfigOutput() ChatEngineCommonConfigOutput

func (ChatEngineCommonConfigArgs) ToChatEngineCommonConfigOutputWithContext added in v7.8.0 

func (i ChatEngineCommonConfigArgs) ToChatEngineCommonConfigOutputWithContext(ctx context.Context) ChatEngineCommonConfigOutput

func (ChatEngineCommonConfigArgs) ToChatEngineCommonConfigPtrOutput added in v7.8.0 

func (i ChatEngineCommonConfigArgs) ToChatEngineCommonConfigPtrOutput() ChatEngineCommonConfigPtrOutput

func (ChatEngineCommonConfigArgs) ToChatEngineCommonConfigPtrOutputWithContext added in v7.8.0 

func (i ChatEngineCommonConfigArgs) ToChatEngineCommonConfigPtrOutputWithContext(ctx context.Context) ChatEngineCommonConfigPtrOutput

type ChatEngineCommonConfigInput added in v7.8.0 

type ChatEngineCommonConfigInput interface {
	pulumi.Input

	ToChatEngineCommonConfigOutput() ChatEngineCommonConfigOutput
	ToChatEngineCommonConfigOutputWithContext(context.Context) ChatEngineCommonConfigOutput
}

ChatEngineCommonConfigInput is an input type that accepts ChatEngineCommonConfigArgs and ChatEngineCommonConfigOutput values. You can construct a concrete instance of `ChatEngineCommonConfigInput` via: 

ChatEngineCommonConfigArgs{...}

type ChatEngineCommonConfigOutput added in v7.8.0 

type ChatEngineCommonConfigOutput struct{ *pulumi.OutputState }

func (ChatEngineCommonConfigOutput) CompanyName added in v7.8.0 

func (o ChatEngineCommonConfigOutput) CompanyName() pulumi.StringPtrOutput

The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.

func (ChatEngineCommonConfigOutput) ElementType added in v7.8.0 

func (ChatEngineCommonConfigOutput) ElementType() reflect.Type

func (ChatEngineCommonConfigOutput) ToChatEngineCommonConfigOutput added in v7.8.0 

func (o ChatEngineCommonConfigOutput) ToChatEngineCommonConfigOutput() ChatEngineCommonConfigOutput

func (ChatEngineCommonConfigOutput) ToChatEngineCommonConfigOutputWithContext added in v7.8.0 

func (o ChatEngineCommonConfigOutput) ToChatEngineCommonConfigOutputWithContext(ctx context.Context) ChatEngineCommonConfigOutput

func (ChatEngineCommonConfigOutput) ToChatEngineCommonConfigPtrOutput added in v7.8.0 

func (o ChatEngineCommonConfigOutput) ToChatEngineCommonConfigPtrOutput() ChatEngineCommonConfigPtrOutput

func (ChatEngineCommonConfigOutput) ToChatEngineCommonConfigPtrOutputWithContext added in v7.8.0 

func (o ChatEngineCommonConfigOutput) ToChatEngineCommonConfigPtrOutputWithContext(ctx context.Context) ChatEngineCommonConfigPtrOutput

type ChatEngineCommonConfigPtrInput added in v7.8.0 

type ChatEngineCommonConfigPtrInput interface {
	pulumi.Input

	ToChatEngineCommonConfigPtrOutput() ChatEngineCommonConfigPtrOutput
	ToChatEngineCommonConfigPtrOutputWithContext(context.Context) ChatEngineCommonConfigPtrOutput
}

ChatEngineCommonConfigPtrInput is an input type that accepts ChatEngineCommonConfigArgs, ChatEngineCommonConfigPtr and ChatEngineCommonConfigPtrOutput values. You can construct a concrete instance of `ChatEngineCommonConfigPtrInput` via: 

        ChatEngineCommonConfigArgs{...}

or:

        nil

func ChatEngineCommonConfigPtr added in v7.8.0 

func ChatEngineCommonConfigPtr(v *ChatEngineCommonConfigArgs) ChatEngineCommonConfigPtrInput

type ChatEngineCommonConfigPtrOutput added in v7.8.0 

type ChatEngineCommonConfigPtrOutput struct{ *pulumi.OutputState }

func (ChatEngineCommonConfigPtrOutput) CompanyName added in v7.8.0 

func (o ChatEngineCommonConfigPtrOutput) CompanyName() pulumi.StringPtrOutput

The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.

func (ChatEngineCommonConfigPtrOutput) Elem added in v7.8.0 

func (o ChatEngineCommonConfigPtrOutput) Elem() ChatEngineCommonConfigOutput

func (ChatEngineCommonConfigPtrOutput) ElementType added in v7.8.0 

func (ChatEngineCommonConfigPtrOutput) ElementType() reflect.Type

func (ChatEngineCommonConfigPtrOutput) ToChatEngineCommonConfigPtrOutput added in v7.8.0 

func (o ChatEngineCommonConfigPtrOutput) ToChatEngineCommonConfigPtrOutput() ChatEngineCommonConfigPtrOutput

func (ChatEngineCommonConfigPtrOutput) ToChatEngineCommonConfigPtrOutputWithContext added in v7.8.0 

func (o ChatEngineCommonConfigPtrOutput) ToChatEngineCommonConfigPtrOutputWithContext(ctx context.Context) ChatEngineCommonConfigPtrOutput

type ChatEngineInput added in v7.8.0 

type ChatEngineInput interface {
	pulumi.Input

	ToChatEngineOutput() ChatEngineOutput
	ToChatEngineOutputWithContext(ctx context.Context) ChatEngineOutput
}

type ChatEngineMap added in v7.8.0 

type ChatEngineMap map[string]ChatEngineInput

func (ChatEngineMap) ElementType added in v7.8.0 

func (ChatEngineMap) ElementType() reflect.Type

func (ChatEngineMap) ToChatEngineMapOutput added in v7.8.0 

func (i ChatEngineMap) ToChatEngineMapOutput() ChatEngineMapOutput

func (ChatEngineMap) ToChatEngineMapOutputWithContext added in v7.8.0 

func (i ChatEngineMap) ToChatEngineMapOutputWithContext(ctx context.Context) ChatEngineMapOutput

type ChatEngineMapInput added in v7.8.0 

type ChatEngineMapInput interface {
	pulumi.Input

	ToChatEngineMapOutput() ChatEngineMapOutput
	ToChatEngineMapOutputWithContext(context.Context) ChatEngineMapOutput
}

ChatEngineMapInput is an input type that accepts ChatEngineMap and ChatEngineMapOutput values. You can construct a concrete instance of `ChatEngineMapInput` via: 

ChatEngineMap{ "key": ChatEngineArgs{...} }

type ChatEngineMapOutput added in v7.8.0 

type ChatEngineMapOutput struct{ *pulumi.OutputState }

func (ChatEngineMapOutput) ElementType added in v7.8.0 

func (ChatEngineMapOutput) ElementType() reflect.Type

func (ChatEngineMapOutput) MapIndex added in v7.8.0 

func (o ChatEngineMapOutput) MapIndex(k pulumi.StringInput) ChatEngineOutput

func (ChatEngineMapOutput) ToChatEngineMapOutput added in v7.8.0 

func (o ChatEngineMapOutput) ToChatEngineMapOutput() ChatEngineMapOutput

func (ChatEngineMapOutput) ToChatEngineMapOutputWithContext added in v7.8.0 

func (o ChatEngineMapOutput) ToChatEngineMapOutputWithContext(ctx context.Context) ChatEngineMapOutput

type ChatEngineOutput added in v7.8.0 

type ChatEngineOutput struct{ *pulumi.OutputState }

func (ChatEngineOutput) ChatEngineConfig added in v7.8.0 

func (o ChatEngineOutput) ChatEngineConfig() ChatEngineChatEngineConfigOutput

Configurations for a chat Engine. Structure is documented below.

func (ChatEngineOutput) ChatEngineMetadatas added in v7.8.0 

func (o ChatEngineOutput) ChatEngineMetadatas() ChatEngineChatEngineMetadataArrayOutput

Additional information of the Chat Engine. Structure is documented below.

func (ChatEngineOutput) CollectionId added in v7.8.0 

func (o ChatEngineOutput) CollectionId() pulumi.StringOutput

The collection ID.

func (ChatEngineOutput) CommonConfig added in v7.8.0 

func (o ChatEngineOutput) CommonConfig() ChatEngineCommonConfigPtrOutput

Common config spec that specifies the metadata of the engine. Structure is documented below.

func (ChatEngineOutput) CreateTime added in v7.8.0 

func (o ChatEngineOutput) CreateTime() pulumi.StringOutput

Timestamp the Engine was created at.

func (ChatEngineOutput) DataStoreIds added in v7.8.0 

func (o ChatEngineOutput) DataStoreIds() pulumi.StringArrayOutput

The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be `SOLUTION_TYPE_CHAT`. Adding or removing data stores will force recreation.

func (ChatEngineOutput) DisplayName added in v7.8.0 

func (o ChatEngineOutput) DisplayName() pulumi.StringOutput

The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

func (ChatEngineOutput) ElementType added in v7.8.0 

func (ChatEngineOutput) ElementType() reflect.Type

func (ChatEngineOutput) EngineId added in v7.8.0 

func (o ChatEngineOutput) EngineId() pulumi.StringOutput

The ID to use for chat engine.

func (ChatEngineOutput) IndustryVertical added in v7.8.0 

func (o ChatEngineOutput) IndustryVertical() pulumi.StringPtrOutput

The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine. Default value is `GENERIC`. Possible values are: `GENERIC`.

func (ChatEngineOutput) Location added in v7.8.0 

func (o ChatEngineOutput) Location() pulumi.StringOutput

Location.

func (ChatEngineOutput) Name added in v7.8.0 

func (o ChatEngineOutput) Name() pulumi.StringOutput

The unique full resource name of the chat 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.

func (ChatEngineOutput) Project added in v7.8.0 

func (o ChatEngineOutput) Project() pulumi.StringOutput

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

func (ChatEngineOutput) ToChatEngineOutput added in v7.8.0 

func (o ChatEngineOutput) ToChatEngineOutput() ChatEngineOutput

func (ChatEngineOutput) ToChatEngineOutputWithContext added in v7.8.0 

func (o ChatEngineOutput) ToChatEngineOutputWithContext(ctx context.Context) ChatEngineOutput

func (ChatEngineOutput) UpdateTime added in v7.8.0 

func (o ChatEngineOutput) UpdateTime() pulumi.StringOutput

Timestamp the Engine was last updated.

type ChatEngineState added in v7.8.0 

type ChatEngineState struct {
	// Configurations for a chat Engine.
	// Structure is documented below.
	ChatEngineConfig ChatEngineChatEngineConfigPtrInput
	// Additional information of the Chat Engine.
	// Structure is documented below.
	ChatEngineMetadatas ChatEngineChatEngineMetadataArrayInput
	// The collection ID.
	CollectionId pulumi.StringPtrInput
	// Common config spec that specifies the metadata of the engine.
	// Structure is documented below.
	CommonConfig ChatEngineCommonConfigPtrInput
	// Timestamp the Engine was created at.
	CreateTime pulumi.StringPtrInput
	// The data stores associated with this engine. Multiple DataStores in the same Collection can be associated here. All listed DataStores must be `SOLUTION_TYPE_CHAT`. Adding or removing data stores will force recreation.
	DataStoreIds pulumi.StringArrayInput
	// The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
	DisplayName pulumi.StringPtrInput
	// The ID to use for chat engine.
	EngineId pulumi.StringPtrInput
	// The industry vertical that the chat engine registers. Vertical on Engine has to match vertical of the DataStore linked to the engine.
	// Default value is `GENERIC`.
	// Possible values are: `GENERIC`.
	IndustryVertical pulumi.StringPtrInput
	// Location.
	Location pulumi.StringPtrInput
	// The unique full resource name of the chat 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.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// Timestamp the Engine was last updated.
	UpdateTime pulumi.StringPtrInput
}

func (ChatEngineState) ElementType added in v7.8.0 

func (ChatEngineState) ElementType() reflect.Type

type DataStore 

type DataStore struct {
	pulumi.CustomResourceState

	// The content config of the data store.
	// Possible values are: `NO_CONTENT`, `CONTENT_REQUIRED`, `PUBLIC_WEBSITE`.
	ContentConfig pulumi.StringOutput `pulumi:"contentConfig"`
	// If true, an advanced data store for site search will be created. If the
	// data store is not configured as site search (GENERIC vertical and
	// PUBLIC_WEBSITE contentConfig), this flag will be ignored.
	CreateAdvancedSiteSearch pulumi.BoolPtrOutput `pulumi:"createAdvancedSiteSearch"`
	// Timestamp when the DataStore was created.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// The unique id of the data store.
	//
	// ***
	DataStoreId pulumi.StringOutput `pulumi:"dataStoreId"`
	// The id of the default Schema associated with this data store.
	DefaultSchemaId pulumi.StringOutput `pulumi:"defaultSchemaId"`
	// The display name of the data store. This field must be a UTF-8 encoded
	// string with a length limit of 128 characters.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// The industry vertical that the data store registers.
	// Possible values are: `GENERIC`, `MEDIA`.
	IndustryVertical pulumi.StringOutput `pulumi:"industryVertical"`
	// The geographic location where the data store should reside. The value can
	// only be one of "global", "us" and "eu".
	Location pulumi.StringOutput `pulumi:"location"`
	// The unique full resource name of the data store. Values are of the format
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	Name pulumi.StringOutput `pulumi:"name"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// The solutions that the data store enrolls.
	// Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`.
	SolutionTypes pulumi.StringArrayOutput `pulumi:"solutionTypes"`
}

Data store is a collection of websites and documents used to find answers for end-user's questions in Discovery Engine (a.k.a. Vertex AI Search and Conversation).

To get more information about DataStore, see:

* [API documentation](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.dataStores) * How-to Guides

## Example Usage ### Discoveryengine Datastore Basic

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/discoveryengine"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := discoveryengine.NewDataStore(ctx, "basic", &discoveryengine.DataStoreArgs{
			ContentConfig:            pulumi.String("NO_CONTENT"),
			CreateAdvancedSiteSearch: pulumi.Bool(false),
			DataStoreId:              pulumi.String("data-store-id"),
			DisplayName:              pulumi.String("tf-test-structured-datastore"),
			IndustryVertical:         pulumi.String("GENERIC"),
			Location:                 pulumi.String("global"),
			SolutionTypes: pulumi.StringArray{
				pulumi.String("SOLUTION_TYPE_SEARCH"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

DataStore can be imported using any of these accepted formats:

  • `projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}`

  • `{{project}}/{{location}}/{{data_store_id}}`

  • `{{location}}/{{data_store_id}}`

    When using the `pulumi import` command, DataStore can be imported using one of the formats above. For example:

```sh $ pulumi import gcp:discoveryengine/dataStore:DataStore default projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}} ```

```sh $ pulumi import gcp:discoveryengine/dataStore:DataStore default {{project}}/{{location}}/{{data_store_id}} ```

```sh $ pulumi import gcp:discoveryengine/dataStore:DataStore default {{location}}/{{data_store_id}} ```

func GetDataStore 

func GetDataStore(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DataStoreState, opts ...pulumi.ResourceOption) (*DataStore, error)

GetDataStore gets an existing DataStore resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDataStore 

func NewDataStore(ctx *pulumi.Context,
	name string, args *DataStoreArgs, opts ...pulumi.ResourceOption) (*DataStore, error)

NewDataStore registers a new resource with the given unique name, arguments, and options.

func (*DataStore) ElementType 

func (*DataStore) ElementType() reflect.Type

func (*DataStore) ToDataStoreOutput 

func (i *DataStore) ToDataStoreOutput() DataStoreOutput

func (*DataStore) ToDataStoreOutputWithContext 

func (i *DataStore) ToDataStoreOutputWithContext(ctx context.Context) DataStoreOutput

type DataStoreArgs 

type DataStoreArgs struct {
	// The content config of the data store.
	// Possible values are: `NO_CONTENT`, `CONTENT_REQUIRED`, `PUBLIC_WEBSITE`.
	ContentConfig pulumi.StringInput
	// If true, an advanced data store for site search will be created. If the
	// data store is not configured as site search (GENERIC vertical and
	// PUBLIC_WEBSITE contentConfig), this flag will be ignored.
	CreateAdvancedSiteSearch pulumi.BoolPtrInput
	// The unique id of the data store.
	//
	// ***
	DataStoreId pulumi.StringInput
	// The display name of the data store. This field must be a UTF-8 encoded
	// string with a length limit of 128 characters.
	DisplayName pulumi.StringInput
	// The industry vertical that the data store registers.
	// Possible values are: `GENERIC`, `MEDIA`.
	IndustryVertical pulumi.StringInput
	// The geographic location where the data store should reside. The value can
	// only be one of "global", "us" and "eu".
	Location pulumi.StringInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// The solutions that the data store enrolls.
	// Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`.
	SolutionTypes pulumi.StringArrayInput
}

The set of arguments for constructing a DataStore resource.

func (DataStoreArgs) ElementType 

func (DataStoreArgs) ElementType() reflect.Type

type DataStoreArray 

type DataStoreArray []DataStoreInput

func (DataStoreArray) ElementType 

func (DataStoreArray) ElementType() reflect.Type

func (DataStoreArray) ToDataStoreArrayOutput 

func (i DataStoreArray) ToDataStoreArrayOutput() DataStoreArrayOutput

func (DataStoreArray) ToDataStoreArrayOutputWithContext 

func (i DataStoreArray) ToDataStoreArrayOutputWithContext(ctx context.Context) DataStoreArrayOutput

type DataStoreArrayInput 

type DataStoreArrayInput interface {
	pulumi.Input

	ToDataStoreArrayOutput() DataStoreArrayOutput
	ToDataStoreArrayOutputWithContext(context.Context) DataStoreArrayOutput
}

DataStoreArrayInput is an input type that accepts DataStoreArray and DataStoreArrayOutput values. You can construct a concrete instance of `DataStoreArrayInput` via: 

DataStoreArray{ DataStoreArgs{...} }

type DataStoreArrayOutput 

type DataStoreArrayOutput struct{ *pulumi.OutputState }

func (DataStoreArrayOutput) ElementType 

func (DataStoreArrayOutput) ElementType() reflect.Type

func (DataStoreArrayOutput) Index 

func (o DataStoreArrayOutput) Index(i pulumi.IntInput) DataStoreOutput

func (DataStoreArrayOutput) ToDataStoreArrayOutput 

func (o DataStoreArrayOutput) ToDataStoreArrayOutput() DataStoreArrayOutput

func (DataStoreArrayOutput) ToDataStoreArrayOutputWithContext 

func (o DataStoreArrayOutput) ToDataStoreArrayOutputWithContext(ctx context.Context) DataStoreArrayOutput

type DataStoreInput 

type DataStoreInput interface {
	pulumi.Input

	ToDataStoreOutput() DataStoreOutput
	ToDataStoreOutputWithContext(ctx context.Context) DataStoreOutput
}

type DataStoreMap 

type DataStoreMap map[string]DataStoreInput

func (DataStoreMap) ElementType 

func (DataStoreMap) ElementType() reflect.Type

func (DataStoreMap) ToDataStoreMapOutput 

func (i DataStoreMap) ToDataStoreMapOutput() DataStoreMapOutput

func (DataStoreMap) ToDataStoreMapOutputWithContext 

func (i DataStoreMap) ToDataStoreMapOutputWithContext(ctx context.Context) DataStoreMapOutput

type DataStoreMapInput 

type DataStoreMapInput interface {
	pulumi.Input

	ToDataStoreMapOutput() DataStoreMapOutput
	ToDataStoreMapOutputWithContext(context.Context) DataStoreMapOutput
}

DataStoreMapInput is an input type that accepts DataStoreMap and DataStoreMapOutput values. You can construct a concrete instance of `DataStoreMapInput` via: 

DataStoreMap{ "key": DataStoreArgs{...} }

type DataStoreMapOutput 

type DataStoreMapOutput struct{ *pulumi.OutputState }

func (DataStoreMapOutput) ElementType 

func (DataStoreMapOutput) ElementType() reflect.Type

func (DataStoreMapOutput) MapIndex 

func (o DataStoreMapOutput) MapIndex(k pulumi.StringInput) DataStoreOutput

func (DataStoreMapOutput) ToDataStoreMapOutput 

func (o DataStoreMapOutput) ToDataStoreMapOutput() DataStoreMapOutput

func (DataStoreMapOutput) ToDataStoreMapOutputWithContext 

func (o DataStoreMapOutput) ToDataStoreMapOutputWithContext(ctx context.Context) DataStoreMapOutput

type DataStoreOutput 

type DataStoreOutput struct{ *pulumi.OutputState }

func (DataStoreOutput) ContentConfig 

func (o DataStoreOutput) ContentConfig() pulumi.StringOutput

The content config of the data store. Possible values are: `NO_CONTENT`, `CONTENT_REQUIRED`, `PUBLIC_WEBSITE`.

func (DataStoreOutput) CreateAdvancedSiteSearch 

func (o DataStoreOutput) CreateAdvancedSiteSearch() pulumi.BoolPtrOutput

If true, an advanced data store for site search will be created. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE contentConfig), this flag will be ignored.

func (DataStoreOutput) CreateTime 

func (o DataStoreOutput) CreateTime() pulumi.StringOutput

Timestamp when the DataStore was created.

func (DataStoreOutput) DataStoreId 

func (o DataStoreOutput) DataStoreId() pulumi.StringOutput

The unique id of the data store.

***

func (DataStoreOutput) DefaultSchemaId 

func (o DataStoreOutput) DefaultSchemaId() pulumi.StringOutput

The id of the default Schema associated with this data store.

func (DataStoreOutput) DisplayName 

func (o DataStoreOutput) DisplayName() pulumi.StringOutput

The display name of the data store. This field must be a UTF-8 encoded string with a length limit of 128 characters.

func (DataStoreOutput) ElementType 

func (DataStoreOutput) ElementType() reflect.Type

func (DataStoreOutput) IndustryVertical 

func (o DataStoreOutput) IndustryVertical() pulumi.StringOutput

The industry vertical that the data store registers. Possible values are: `GENERIC`, `MEDIA`.

func (DataStoreOutput) Location 

func (o DataStoreOutput) Location() pulumi.StringOutput

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

func (DataStoreOutput) Name 

func (o DataStoreOutput) Name() pulumi.StringOutput

The unique full resource name of the data store. Values are of the format `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

func (DataStoreOutput) Project 

func (o DataStoreOutput) Project() pulumi.StringOutput

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

func (DataStoreOutput) SolutionTypes 

func (o DataStoreOutput) SolutionTypes() pulumi.StringArrayOutput

The solutions that the data store enrolls. Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`.

func (DataStoreOutput) ToDataStoreOutput 

func (o DataStoreOutput) ToDataStoreOutput() DataStoreOutput

func (DataStoreOutput) ToDataStoreOutputWithContext 

func (o DataStoreOutput) ToDataStoreOutputWithContext(ctx context.Context) DataStoreOutput

type DataStoreState 

type DataStoreState struct {
	// The content config of the data store.
	// Possible values are: `NO_CONTENT`, `CONTENT_REQUIRED`, `PUBLIC_WEBSITE`.
	ContentConfig pulumi.StringPtrInput
	// If true, an advanced data store for site search will be created. If the
	// data store is not configured as site search (GENERIC vertical and
	// PUBLIC_WEBSITE contentConfig), this flag will be ignored.
	CreateAdvancedSiteSearch pulumi.BoolPtrInput
	// Timestamp when the DataStore was created.
	CreateTime pulumi.StringPtrInput
	// The unique id of the data store.
	//
	// ***
	DataStoreId pulumi.StringPtrInput
	// The id of the default Schema associated with this data store.
	DefaultSchemaId pulumi.StringPtrInput
	// The display name of the data store. This field must be a UTF-8 encoded
	// string with a length limit of 128 characters.
	DisplayName pulumi.StringPtrInput
	// The industry vertical that the data store registers.
	// Possible values are: `GENERIC`, `MEDIA`.
	IndustryVertical pulumi.StringPtrInput
	// The geographic location where the data store should reside. The value can
	// only be one of "global", "us" and "eu".
	Location pulumi.StringPtrInput
	// The unique full resource name of the data store. Values are of the format
	// `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
	// This field must be a UTF-8 encoded string with a length limit of 1024
	// characters.
	Name pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// The solutions that the data store enrolls.
	// Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`.
	SolutionTypes pulumi.StringArrayInput
}

func (DataStoreState) ElementType 

func (DataStoreState) ElementType() reflect.Type

type SearchEngine added in v7.8.0 

type SearchEngine struct {
	pulumi.CustomResourceState

	// The collection ID.
	CollectionId pulumi.StringOutput `pulumi:"collectionId"`
	// Common config spec that specifies the metadata of the engine.
	// Structure is documented below.
	CommonConfig SearchEngineCommonConfigPtrOutput `pulumi:"commonConfig"`
	// Timestamp the Engine was created at.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// 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.StringArrayOutput `pulumi:"dataStoreIds"`
	// Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Unique ID to use for Search Engine App.
	EngineId pulumi.StringOutput `pulumi:"engineId"`
	// 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`.
	IndustryVertical pulumi.StringPtrOutput `pulumi:"industryVertical"`
	// Location.
	Location pulumi.StringOutput `pulumi:"location"`
	// 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.StringOutput `pulumi:"name"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// Configurations for a Search Engine.
	// Structure is documented below.
	SearchEngineConfig SearchEngineSearchEngineConfigOutput `pulumi:"searchEngineConfig"`
	// Timestamp the Engine was last updated.
	UpdateTime pulumi.StringOutput `pulumi:"updateTime"`
}

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

## Example Usage ### Discoveryengine Searchengine Basic

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/discoveryengine"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basicDataStore, err := discoveryengine.NewDataStore(ctx, "basicDataStore", &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, "basicSearchEngine", &discoveryengine.SearchEngineArgs{
			EngineId:     pulumi.String("example-engine-id"),
			CollectionId: pulumi.String("default_collection"),
			Location:     basicDataStore.Location,
			DisplayName:  pulumi.String("Example Display Name"),
			DataStoreIds: pulumi.StringArray{
				basicDataStore.DataStoreId,
			},
			SearchEngineConfig: nil,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## 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}} ```

```sh $ pulumi import gcp:discoveryengine/searchEngine:SearchEngine default {{project}}/{{location}}/{{collection_id}}/{{engine_id}} ```

```sh $ pulumi import gcp:discoveryengine/searchEngine:SearchEngine default {{location}}/{{collection_id}}/{{engine_id}} ```

func GetSearchEngine added in v7.8.0 

func GetSearchEngine(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SearchEngineState, opts ...pulumi.ResourceOption) (*SearchEngine, error)

GetSearchEngine gets an existing SearchEngine resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSearchEngine added in v7.8.0 

func NewSearchEngine(ctx *pulumi.Context,
	name string, args *SearchEngineArgs, opts ...pulumi.ResourceOption) (*SearchEngine, error)

NewSearchEngine registers a new resource with the given unique name, arguments, and options.

func (*SearchEngine) ElementType added in v7.8.0 

func (*SearchEngine) ElementType() reflect.Type

func (*SearchEngine) ToSearchEngineOutput added in v7.8.0 

func (i *SearchEngine) ToSearchEngineOutput() SearchEngineOutput

func (*SearchEngine) ToSearchEngineOutputWithContext added in v7.8.0 

func (i *SearchEngine) ToSearchEngineOutputWithContext(ctx context.Context) SearchEngineOutput

type SearchEngineArgs added in v7.8.0 

type SearchEngineArgs struct {
	// The collection ID.
	CollectionId pulumi.StringInput
	// Common config spec that specifies the metadata of the engine.
	// Structure is documented below.
	CommonConfig SearchEngineCommonConfigPtrInput
	// 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.StringArrayInput
	// Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
	DisplayName pulumi.StringInput
	// Unique ID to use for Search Engine App.
	EngineId pulumi.StringInput
	// 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`.
	IndustryVertical pulumi.StringPtrInput
	// Location.
	Location pulumi.StringInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// Configurations for a Search Engine.
	// Structure is documented below.
	SearchEngineConfig SearchEngineSearchEngineConfigInput
}

The set of arguments for constructing a SearchEngine resource.

func (SearchEngineArgs) ElementType added in v7.8.0 

func (SearchEngineArgs) ElementType() reflect.Type

type SearchEngineArray added in v7.8.0 

type SearchEngineArray []SearchEngineInput

func (SearchEngineArray) ElementType added in v7.8.0 

func (SearchEngineArray) ElementType() reflect.Type

func (SearchEngineArray) ToSearchEngineArrayOutput added in v7.8.0 

func (i SearchEngineArray) ToSearchEngineArrayOutput() SearchEngineArrayOutput

func (SearchEngineArray) ToSearchEngineArrayOutputWithContext added in v7.8.0 

func (i SearchEngineArray) ToSearchEngineArrayOutputWithContext(ctx context.Context) SearchEngineArrayOutput

type SearchEngineArrayInput added in v7.8.0 

type SearchEngineArrayInput interface {
	pulumi.Input

	ToSearchEngineArrayOutput() SearchEngineArrayOutput
	ToSearchEngineArrayOutputWithContext(context.Context) SearchEngineArrayOutput
}

SearchEngineArrayInput is an input type that accepts SearchEngineArray and SearchEngineArrayOutput values. You can construct a concrete instance of `SearchEngineArrayInput` via: 

SearchEngineArray{ SearchEngineArgs{...} }

type SearchEngineArrayOutput added in v7.8.0 

type SearchEngineArrayOutput struct{ *pulumi.OutputState }

func (SearchEngineArrayOutput) ElementType added in v7.8.0 

func (SearchEngineArrayOutput) ElementType() reflect.Type

func (SearchEngineArrayOutput) Index added in v7.8.0 

func (o SearchEngineArrayOutput) Index(i pulumi.IntInput) SearchEngineOutput

func (SearchEngineArrayOutput) ToSearchEngineArrayOutput added in v7.8.0 

func (o SearchEngineArrayOutput) ToSearchEngineArrayOutput() SearchEngineArrayOutput

func (SearchEngineArrayOutput) ToSearchEngineArrayOutputWithContext added in v7.8.0 

func (o SearchEngineArrayOutput) ToSearchEngineArrayOutputWithContext(ctx context.Context) SearchEngineArrayOutput

type SearchEngineCommonConfig added in v7.8.0 

type SearchEngineCommonConfig struct {
	// 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 `pulumi:"companyName"`
}

type SearchEngineCommonConfigArgs added in v7.8.0 

type SearchEngineCommonConfigArgs struct {
	// The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.cd
	CompanyName pulumi.StringPtrInput `pulumi:"companyName"`
}

func (SearchEngineCommonConfigArgs) ElementType added in v7.8.0 

func (SearchEngineCommonConfigArgs) ElementType() reflect.Type

func (SearchEngineCommonConfigArgs) ToSearchEngineCommonConfigOutput added in v7.8.0 

func (i SearchEngineCommonConfigArgs) ToSearchEngineCommonConfigOutput() SearchEngineCommonConfigOutput

func (SearchEngineCommonConfigArgs) ToSearchEngineCommonConfigOutputWithContext added in v7.8.0 

func (i SearchEngineCommonConfigArgs) ToSearchEngineCommonConfigOutputWithContext(ctx context.Context) SearchEngineCommonConfigOutput

func (SearchEngineCommonConfigArgs) ToSearchEngineCommonConfigPtrOutput added in v7.8.0 

func (i SearchEngineCommonConfigArgs) ToSearchEngineCommonConfigPtrOutput() SearchEngineCommonConfigPtrOutput

func (SearchEngineCommonConfigArgs) ToSearchEngineCommonConfigPtrOutputWithContext added in v7.8.0 

func (i SearchEngineCommonConfigArgs) ToSearchEngineCommonConfigPtrOutputWithContext(ctx context.Context) SearchEngineCommonConfigPtrOutput

type SearchEngineCommonConfigInput added in v7.8.0 

type SearchEngineCommonConfigInput interface {
	pulumi.Input

	ToSearchEngineCommonConfigOutput() SearchEngineCommonConfigOutput
	ToSearchEngineCommonConfigOutputWithContext(context.Context) SearchEngineCommonConfigOutput
}

SearchEngineCommonConfigInput is an input type that accepts SearchEngineCommonConfigArgs and SearchEngineCommonConfigOutput values. You can construct a concrete instance of `SearchEngineCommonConfigInput` via: 

SearchEngineCommonConfigArgs{...}

type SearchEngineCommonConfigOutput added in v7.8.0 

type SearchEngineCommonConfigOutput struct{ *pulumi.OutputState }

func (SearchEngineCommonConfigOutput) CompanyName added in v7.8.0 

func (o SearchEngineCommonConfigOutput) CompanyName() pulumi.StringPtrOutput

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

func (SearchEngineCommonConfigOutput) ElementType added in v7.8.0 

func (SearchEngineCommonConfigOutput) ElementType() reflect.Type

func (SearchEngineCommonConfigOutput) ToSearchEngineCommonConfigOutput added in v7.8.0 

func (o SearchEngineCommonConfigOutput) ToSearchEngineCommonConfigOutput() SearchEngineCommonConfigOutput

func (SearchEngineCommonConfigOutput) ToSearchEngineCommonConfigOutputWithContext added in v7.8.0 

func (o SearchEngineCommonConfigOutput) ToSearchEngineCommonConfigOutputWithContext(ctx context.Context) SearchEngineCommonConfigOutput

func (SearchEngineCommonConfigOutput) ToSearchEngineCommonConfigPtrOutput added in v7.8.0 

func (o SearchEngineCommonConfigOutput) ToSearchEngineCommonConfigPtrOutput() SearchEngineCommonConfigPtrOutput

func (SearchEngineCommonConfigOutput) ToSearchEngineCommonConfigPtrOutputWithContext added in v7.8.0 

func (o SearchEngineCommonConfigOutput) ToSearchEngineCommonConfigPtrOutputWithContext(ctx context.Context) SearchEngineCommonConfigPtrOutput

type SearchEngineCommonConfigPtrInput added in v7.8.0 

type SearchEngineCommonConfigPtrInput interface {
	pulumi.Input

	ToSearchEngineCommonConfigPtrOutput() SearchEngineCommonConfigPtrOutput
	ToSearchEngineCommonConfigPtrOutputWithContext(context.Context) SearchEngineCommonConfigPtrOutput
}

SearchEngineCommonConfigPtrInput is an input type that accepts SearchEngineCommonConfigArgs, SearchEngineCommonConfigPtr and SearchEngineCommonConfigPtrOutput values. You can construct a concrete instance of `SearchEngineCommonConfigPtrInput` via: 

        SearchEngineCommonConfigArgs{...}

or:

        nil

func SearchEngineCommonConfigPtr added in v7.8.0 

func SearchEngineCommonConfigPtr(v *SearchEngineCommonConfigArgs) SearchEngineCommonConfigPtrInput

type SearchEngineCommonConfigPtrOutput added in v7.8.0 

type SearchEngineCommonConfigPtrOutput struct{ *pulumi.OutputState }

func (SearchEngineCommonConfigPtrOutput) CompanyName added in v7.8.0 

func (o SearchEngineCommonConfigPtrOutput) CompanyName() pulumi.StringPtrOutput

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

func (SearchEngineCommonConfigPtrOutput) Elem added in v7.8.0 

func (o SearchEngineCommonConfigPtrOutput) Elem() SearchEngineCommonConfigOutput

func (SearchEngineCommonConfigPtrOutput) ElementType added in v7.8.0 

func (SearchEngineCommonConfigPtrOutput) ElementType() reflect.Type

func (SearchEngineCommonConfigPtrOutput) ToSearchEngineCommonConfigPtrOutput added in v7.8.0 

func (o SearchEngineCommonConfigPtrOutput) ToSearchEngineCommonConfigPtrOutput() SearchEngineCommonConfigPtrOutput

func (SearchEngineCommonConfigPtrOutput) ToSearchEngineCommonConfigPtrOutputWithContext added in v7.8.0 

func (o SearchEngineCommonConfigPtrOutput) ToSearchEngineCommonConfigPtrOutputWithContext(ctx context.Context) SearchEngineCommonConfigPtrOutput

type SearchEngineInput added in v7.8.0 

type SearchEngineInput interface {
	pulumi.Input

	ToSearchEngineOutput() SearchEngineOutput
	ToSearchEngineOutputWithContext(ctx context.Context) SearchEngineOutput
}

type SearchEngineMap added in v7.8.0 

type SearchEngineMap map[string]SearchEngineInput

func (SearchEngineMap) ElementType added in v7.8.0 

func (SearchEngineMap) ElementType() reflect.Type

func (SearchEngineMap) ToSearchEngineMapOutput added in v7.8.0 

func (i SearchEngineMap) ToSearchEngineMapOutput() SearchEngineMapOutput

func (SearchEngineMap) ToSearchEngineMapOutputWithContext added in v7.8.0 

func (i SearchEngineMap) ToSearchEngineMapOutputWithContext(ctx context.Context) SearchEngineMapOutput

type SearchEngineMapInput added in v7.8.0 

type SearchEngineMapInput interface {
	pulumi.Input

	ToSearchEngineMapOutput() SearchEngineMapOutput
	ToSearchEngineMapOutputWithContext(context.Context) SearchEngineMapOutput
}

SearchEngineMapInput is an input type that accepts SearchEngineMap and SearchEngineMapOutput values. You can construct a concrete instance of `SearchEngineMapInput` via: 

SearchEngineMap{ "key": SearchEngineArgs{...} }

type SearchEngineMapOutput added in v7.8.0 

type SearchEngineMapOutput struct{ *pulumi.OutputState }

func (SearchEngineMapOutput) ElementType added in v7.8.0 

func (SearchEngineMapOutput) ElementType() reflect.Type

func (SearchEngineMapOutput) MapIndex added in v7.8.0 

func (o SearchEngineMapOutput) MapIndex(k pulumi.StringInput) SearchEngineOutput

func (SearchEngineMapOutput) ToSearchEngineMapOutput added in v7.8.0 

func (o SearchEngineMapOutput) ToSearchEngineMapOutput() SearchEngineMapOutput

func (SearchEngineMapOutput) ToSearchEngineMapOutputWithContext added in v7.8.0 

func (o SearchEngineMapOutput) ToSearchEngineMapOutputWithContext(ctx context.Context) SearchEngineMapOutput

type SearchEngineOutput added in v7.8.0 

type SearchEngineOutput struct{ *pulumi.OutputState }

func (SearchEngineOutput) CollectionId added in v7.8.0 

func (o SearchEngineOutput) CollectionId() pulumi.StringOutput

The collection ID.

func (SearchEngineOutput) CommonConfig added in v7.8.0 

func (o SearchEngineOutput) CommonConfig() SearchEngineCommonConfigPtrOutput

Common config spec that specifies the metadata of the engine. Structure is documented below.

func (SearchEngineOutput) CreateTime added in v7.8.0 

func (o SearchEngineOutput) CreateTime() pulumi.StringOutput

Timestamp the Engine was created at.

func (SearchEngineOutput) DataStoreIds added in v7.8.0 

func (o SearchEngineOutput) DataStoreIds() pulumi.StringArrayOutput

The data stores associated with this engine. For SOLUTION_TYPE_SEARCH type of engines, they can only associate with at most one data store.

func (SearchEngineOutput) DisplayName added in v7.8.0 

func (o SearchEngineOutput) DisplayName() pulumi.StringOutput

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

func (SearchEngineOutput) ElementType added in v7.8.0 

func (SearchEngineOutput) ElementType() reflect.Type

func (SearchEngineOutput) EngineId added in v7.8.0 

func (o SearchEngineOutput) EngineId() pulumi.StringOutput

Unique ID to use for Search Engine App.

func (SearchEngineOutput) IndustryVertical added in v7.8.0 

func (o SearchEngineOutput) IndustryVertical() pulumi.StringPtrOutput

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`.

func (SearchEngineOutput) Location added in v7.8.0 

func (o SearchEngineOutput) Location() pulumi.StringOutput

Location.

func (SearchEngineOutput) Name added in v7.8.0 

func (o SearchEngineOutput) Name() pulumi.StringOutput

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.

func (SearchEngineOutput) Project added in v7.8.0 

func (o SearchEngineOutput) Project() pulumi.StringOutput

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

func (SearchEngineOutput) SearchEngineConfig added in v7.8.0 

func (o SearchEngineOutput) SearchEngineConfig() SearchEngineSearchEngineConfigOutput

Configurations for a Search Engine. Structure is documented below.

func (SearchEngineOutput) ToSearchEngineOutput added in v7.8.0 

func (o SearchEngineOutput) ToSearchEngineOutput() SearchEngineOutput

func (SearchEngineOutput) ToSearchEngineOutputWithContext added in v7.8.0 

func (o SearchEngineOutput) ToSearchEngineOutputWithContext(ctx context.Context) SearchEngineOutput

func (SearchEngineOutput) UpdateTime added in v7.8.0 

func (o SearchEngineOutput) UpdateTime() pulumi.StringOutput

Timestamp the Engine was last updated.

type SearchEngineSearchEngineConfig added in v7.8.0 

type SearchEngineSearchEngineConfig struct {
	// The add-on that this search engine enables.
	// Each value may be one of: `SEARCH_ADD_ON_LLM`.
	//
	// ***
	SearchAddOns []string `pulumi:"searchAddOns"`
	// 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`.
	SearchTier *string `pulumi:"searchTier"`
}

type SearchEngineSearchEngineConfigArgs added in v7.8.0 

type SearchEngineSearchEngineConfigArgs struct {
	// The add-on that this search engine enables.
	// Each value may be one of: `SEARCH_ADD_ON_LLM`.
	//
	// ***
	SearchAddOns pulumi.StringArrayInput `pulumi:"searchAddOns"`
	// 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`.
	SearchTier pulumi.StringPtrInput `pulumi:"searchTier"`
}

func (SearchEngineSearchEngineConfigArgs) ElementType added in v7.8.0 

func (SearchEngineSearchEngineConfigArgs) ElementType() reflect.Type

func (SearchEngineSearchEngineConfigArgs) ToSearchEngineSearchEngineConfigOutput added in v7.8.0 

func (i SearchEngineSearchEngineConfigArgs) ToSearchEngineSearchEngineConfigOutput() SearchEngineSearchEngineConfigOutput

func (SearchEngineSearchEngineConfigArgs) ToSearchEngineSearchEngineConfigOutputWithContext added in v7.8.0 

func (i SearchEngineSearchEngineConfigArgs) ToSearchEngineSearchEngineConfigOutputWithContext(ctx context.Context) SearchEngineSearchEngineConfigOutput

func (SearchEngineSearchEngineConfigArgs) ToSearchEngineSearchEngineConfigPtrOutput added in v7.8.0 

func (i SearchEngineSearchEngineConfigArgs) ToSearchEngineSearchEngineConfigPtrOutput() SearchEngineSearchEngineConfigPtrOutput

func (SearchEngineSearchEngineConfigArgs) ToSearchEngineSearchEngineConfigPtrOutputWithContext added in v7.8.0 

func (i SearchEngineSearchEngineConfigArgs) ToSearchEngineSearchEngineConfigPtrOutputWithContext(ctx context.Context) SearchEngineSearchEngineConfigPtrOutput

type SearchEngineSearchEngineConfigInput added in v7.8.0 

type SearchEngineSearchEngineConfigInput interface {
	pulumi.Input

	ToSearchEngineSearchEngineConfigOutput() SearchEngineSearchEngineConfigOutput
	ToSearchEngineSearchEngineConfigOutputWithContext(context.Context) SearchEngineSearchEngineConfigOutput
}

SearchEngineSearchEngineConfigInput is an input type that accepts SearchEngineSearchEngineConfigArgs and SearchEngineSearchEngineConfigOutput values. You can construct a concrete instance of `SearchEngineSearchEngineConfigInput` via: 

SearchEngineSearchEngineConfigArgs{...}

type SearchEngineSearchEngineConfigOutput added in v7.8.0 

type SearchEngineSearchEngineConfigOutput struct{ *pulumi.OutputState }

func (SearchEngineSearchEngineConfigOutput) ElementType added in v7.8.0 

func (SearchEngineSearchEngineConfigOutput) ElementType() reflect.Type

func (SearchEngineSearchEngineConfigOutput) SearchAddOns added in v7.8.0 

func (o SearchEngineSearchEngineConfigOutput) SearchAddOns() pulumi.StringArrayOutput

The add-on that this search engine enables. Each value may be one of: `SEARCH_ADD_ON_LLM`.

***

func (SearchEngineSearchEngineConfigOutput) SearchTier added in v7.8.0 

func (o SearchEngineSearchEngineConfigOutput) SearchTier() pulumi.StringPtrOutput

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`.

func (SearchEngineSearchEngineConfigOutput) ToSearchEngineSearchEngineConfigOutput added in v7.8.0 

func (o SearchEngineSearchEngineConfigOutput) ToSearchEngineSearchEngineConfigOutput() SearchEngineSearchEngineConfigOutput

func (SearchEngineSearchEngineConfigOutput) ToSearchEngineSearchEngineConfigOutputWithContext added in v7.8.0 

func (o SearchEngineSearchEngineConfigOutput) ToSearchEngineSearchEngineConfigOutputWithContext(ctx context.Context) SearchEngineSearchEngineConfigOutput

func (SearchEngineSearchEngineConfigOutput) ToSearchEngineSearchEngineConfigPtrOutput added in v7.8.0 

func (o SearchEngineSearchEngineConfigOutput) ToSearchEngineSearchEngineConfigPtrOutput() SearchEngineSearchEngineConfigPtrOutput

func (SearchEngineSearchEngineConfigOutput) ToSearchEngineSearchEngineConfigPtrOutputWithContext added in v7.8.0 

func (o SearchEngineSearchEngineConfigOutput) ToSearchEngineSearchEngineConfigPtrOutputWithContext(ctx context.Context) SearchEngineSearchEngineConfigPtrOutput

type SearchEngineSearchEngineConfigPtrInput added in v7.8.0 

type SearchEngineSearchEngineConfigPtrInput interface {
	pulumi.Input

	ToSearchEngineSearchEngineConfigPtrOutput() SearchEngineSearchEngineConfigPtrOutput
	ToSearchEngineSearchEngineConfigPtrOutputWithContext(context.Context) SearchEngineSearchEngineConfigPtrOutput
}

SearchEngineSearchEngineConfigPtrInput is an input type that accepts SearchEngineSearchEngineConfigArgs, SearchEngineSearchEngineConfigPtr and SearchEngineSearchEngineConfigPtrOutput values. You can construct a concrete instance of `SearchEngineSearchEngineConfigPtrInput` via: 

        SearchEngineSearchEngineConfigArgs{...}

or:

        nil

func SearchEngineSearchEngineConfigPtr added in v7.8.0 

func SearchEngineSearchEngineConfigPtr(v *SearchEngineSearchEngineConfigArgs) SearchEngineSearchEngineConfigPtrInput

type SearchEngineSearchEngineConfigPtrOutput added in v7.8.0 

type SearchEngineSearchEngineConfigPtrOutput struct{ *pulumi.OutputState }

func (SearchEngineSearchEngineConfigPtrOutput) Elem added in v7.8.0 

func (o SearchEngineSearchEngineConfigPtrOutput) Elem() SearchEngineSearchEngineConfigOutput

func (SearchEngineSearchEngineConfigPtrOutput) ElementType added in v7.8.0 

func (SearchEngineSearchEngineConfigPtrOutput) ElementType() reflect.Type

func (SearchEngineSearchEngineConfigPtrOutput) SearchAddOns added in v7.8.0 

func (o SearchEngineSearchEngineConfigPtrOutput) SearchAddOns() pulumi.StringArrayOutput

The add-on that this search engine enables. Each value may be one of: `SEARCH_ADD_ON_LLM`.

***

func (SearchEngineSearchEngineConfigPtrOutput) SearchTier added in v7.8.0 

func (o SearchEngineSearchEngineConfigPtrOutput) SearchTier() pulumi.StringPtrOutput

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`.

func (SearchEngineSearchEngineConfigPtrOutput) ToSearchEngineSearchEngineConfigPtrOutput added in v7.8.0 

func (o SearchEngineSearchEngineConfigPtrOutput) ToSearchEngineSearchEngineConfigPtrOutput() SearchEngineSearchEngineConfigPtrOutput

func (SearchEngineSearchEngineConfigPtrOutput) ToSearchEngineSearchEngineConfigPtrOutputWithContext added in v7.8.0 

func (o SearchEngineSearchEngineConfigPtrOutput) ToSearchEngineSearchEngineConfigPtrOutputWithContext(ctx context.Context) SearchEngineSearchEngineConfigPtrOutput

type SearchEngineState added in v7.8.0 

type SearchEngineState struct {
	// The collection ID.
	CollectionId pulumi.StringPtrInput
	// Common config spec that specifies the metadata of the engine.
	// Structure is documented below.
	CommonConfig SearchEngineCommonConfigPtrInput
	// Timestamp the Engine was created at.
	CreateTime pulumi.StringPtrInput
	// 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.StringArrayInput
	// Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
	DisplayName pulumi.StringPtrInput
	// Unique ID to use for Search Engine App.
	EngineId pulumi.StringPtrInput
	// 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`.
	IndustryVertical pulumi.StringPtrInput
	// Location.
	Location pulumi.StringPtrInput
	// 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.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// Configurations for a Search Engine.
	// Structure is documented below.
	SearchEngineConfig SearchEngineSearchEngineConfigPtrInput
	// Timestamp the Engine was last updated.
	UpdateTime pulumi.StringPtrInput
}

func (SearchEngineState) ElementType added in v7.8.0 

func (SearchEngineState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.