com.pulumi.gcp.discoveryengine.kotlin.DataStoreArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.discoveryengine.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.discoveryengine.DataStoreArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* 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
* * [Create a search data store](https://cloud.google.com/generative-ai-app-builder/docs/create-data-store-es)
* ## Example Usage
* ### Discoveryengine Datastore Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const basic = new gcp.discoveryengine.DataStore("basic", {
* location: "global",
* dataStoreId: "data-store-id",
* displayName: "tf-test-structured-datastore",
* industryVertical: "GENERIC",
* contentConfig: "NO_CONTENT",
* solutionTypes: ["SOLUTION_TYPE_SEARCH"],
* createAdvancedSiteSearch: false,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* basic = gcp.discoveryengine.DataStore("basic",
* location="global",
* data_store_id="data-store-id",
* display_name="tf-test-structured-datastore",
* industry_vertical="GENERIC",
* content_config="NO_CONTENT",
* solution_types=["SOLUTION_TYPE_SEARCH"],
* create_advanced_site_search=False)
* ```
* ```csharp
* 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 = "data-store-id",
* DisplayName = "tf-test-structured-datastore",
* IndustryVertical = "GENERIC",
* ContentConfig = "NO_CONTENT",
* SolutionTypes = new[]
* {
* "SOLUTION_TYPE_SEARCH",
* },
* CreateAdvancedSiteSearch = false,
* });
* });
* ```
* ```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{
* Location: pulumi.String("global"),
* DataStoreId: pulumi.String("data-store-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
* }
* return nil
* })
* }
* ```
* ```java
* 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 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("data-store-id")
* .displayName("tf-test-structured-datastore")
* .industryVertical("GENERIC")
* .contentConfig("NO_CONTENT")
* .solutionTypes("SOLUTION_TYPE_SEARCH")
* .createAdvancedSiteSearch(false)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* basic:
* type: gcp:discoveryengine:DataStore
* properties:
* location: global
* dataStoreId: data-store-id
* displayName: tf-test-structured-datastore
* industryVertical: GENERIC
* contentConfig: NO_CONTENT
* solutionTypes:
* - SOLUTION_TYPE_SEARCH
* createAdvancedSiteSearch: false
* ```
*
* ## 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}}
* ```
* @property contentConfig The content config of the data store.
* Possible values are: `NO_CONTENT`, `CONTENT_REQUIRED`, `PUBLIC_WEBSITE`.
* @property createAdvancedSiteSearch 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.
* @property dataStoreId The unique id of the data store.
* - - -
* @property displayName The display name of the data store. This field must be a UTF-8 encoded
* string with a length limit of 128 characters.
* @property industryVertical The industry vertical that the data store registers.
* Possible values are: `GENERIC`, `MEDIA`.
* @property location The geographic location where the data store should reside. The value can
* only be one of "global", "us" and "eu".
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
* @property solutionTypes The solutions that the data store enrolls.
* Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`.
*/
public data class DataStoreArgs(
public val contentConfig: Output? = null,
public val createAdvancedSiteSearch: Output? = null,
public val dataStoreId: Output? = null,
public val displayName: Output? = null,
public val industryVertical: Output? = null,
public val location: Output? = null,
public val project: Output? = null,
public val solutionTypes: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.discoveryengine.DataStoreArgs =
com.pulumi.gcp.discoveryengine.DataStoreArgs.builder()
.contentConfig(contentConfig?.applyValue({ args0 -> args0 }))
.createAdvancedSiteSearch(createAdvancedSiteSearch?.applyValue({ args0 -> args0 }))
.dataStoreId(dataStoreId?.applyValue({ args0 -> args0 }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.industryVertical(industryVertical?.applyValue({ args0 -> args0 }))
.location(location?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 }))
.solutionTypes(solutionTypes?.applyValue({ args0 -> args0.map({ args0 -> args0 }) })).build()
}
/**
* Builder for [DataStoreArgs].
*/
@PulumiTagMarker
public class DataStoreArgsBuilder internal constructor() {
private var contentConfig: Output? = null
private var createAdvancedSiteSearch: Output? = null
private var dataStoreId: Output? = null
private var displayName: Output? = null
private var industryVertical: Output? = null
private var location: Output? = null
private var project: Output? = null
private var solutionTypes: Output>? = null
/**
* @param value The content config of the data store.
* Possible values are: `NO_CONTENT`, `CONTENT_REQUIRED`, `PUBLIC_WEBSITE`.
*/
@JvmName("vcoruvkaergqntog")
public suspend fun contentConfig(`value`: Output) {
this.contentConfig = value
}
/**
* @param value 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.
*/
@JvmName("goojmhhukkqitfcv")
public suspend fun createAdvancedSiteSearch(`value`: Output) {
this.createAdvancedSiteSearch = value
}
/**
* @param value The unique id of the data store.
* - - -
*/
@JvmName("msunwhyfgvagjsmx")
public suspend fun dataStoreId(`value`: Output) {
this.dataStoreId = value
}
/**
* @param value The display name of the data store. This field must be a UTF-8 encoded
* string with a length limit of 128 characters.
*/
@JvmName("mvecbpvhructktel")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value The industry vertical that the data store registers.
* Possible values are: `GENERIC`, `MEDIA`.
*/
@JvmName("mqvhwblvublmijnc")
public suspend fun industryVertical(`value`: Output) {
this.industryVertical = value
}
/**
* @param value The geographic location where the data store should reside. The value can
* only be one of "global", "us" and "eu".
*/
@JvmName("xnlmgkygbrveesry")
public suspend fun location(`value`: Output) {
this.location = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("jnfurubexlkvthgy")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value The solutions that the data store enrolls.
* Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`.
*/
@JvmName("dpjgmhmehbkbncpx")
public suspend fun solutionTypes(`value`: Output>) {
this.solutionTypes = value
}
@JvmName("thxgwtowmndfupfm")
public suspend fun solutionTypes(vararg values: Output) {
this.solutionTypes = Output.all(values.asList())
}
/**
* @param values The solutions that the data store enrolls.
* Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`.
*/
@JvmName("hhgdbcsrjihiplcq")
public suspend fun solutionTypes(values: List>) {
this.solutionTypes = Output.all(values)
}
/**
* @param value The content config of the data store.
* Possible values are: `NO_CONTENT`, `CONTENT_REQUIRED`, `PUBLIC_WEBSITE`.
*/
@JvmName("satalrofwnxixkat")
public suspend fun contentConfig(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.contentConfig = mapped
}
/**
* @param value 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.
*/
@JvmName("yccquwggthehnynf")
public suspend fun createAdvancedSiteSearch(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.createAdvancedSiteSearch = mapped
}
/**
* @param value The unique id of the data store.
* - - -
*/
@JvmName("sytjxgrngiqbuiou")
public suspend fun dataStoreId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dataStoreId = mapped
}
/**
* @param value The display name of the data store. This field must be a UTF-8 encoded
* string with a length limit of 128 characters.
*/
@JvmName("ychjorwfvirfklmd")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value The industry vertical that the data store registers.
* Possible values are: `GENERIC`, `MEDIA`.
*/
@JvmName("sjqnknjnbvmulbcd")
public suspend fun industryVertical(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.industryVertical = mapped
}
/**
* @param value The geographic location where the data store should reside. The value can
* only be one of "global", "us" and "eu".
*/
@JvmName("xwmjxynouvilmlvp")
public suspend fun location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.location = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("fupjrtgmvprovmtq")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value The solutions that the data store enrolls.
* Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`.
*/
@JvmName("vjrqxlpatsawfged")
public suspend fun solutionTypes(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.solutionTypes = mapped
}
/**
* @param values The solutions that the data store enrolls.
* Each value may be one of: `SOLUTION_TYPE_RECOMMENDATION`, `SOLUTION_TYPE_SEARCH`, `SOLUTION_TYPE_CHAT`.
*/
@JvmName("fhlongpqcumharne")
public suspend fun solutionTypes(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.solutionTypes = mapped
}
internal fun build(): DataStoreArgs = DataStoreArgs(
contentConfig = contentConfig,
createAdvancedSiteSearch = createAdvancedSiteSearch,
dataStoreId = dataStoreId,
displayName = displayName,
industryVertical = industryVertical,
location = location,
project = project,
solutionTypes = solutionTypes,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy