com.pulumi.gcp.discoveryengine.kotlin.TargetSiteArgs.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
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.20.1.0
Show newest version
@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.TargetSiteArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * TargetSite represents a URI pattern that the users want to confine their
 * search.
 * To get more information about TargetSite, see:
 * * [API documentation](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.dataStores.siteSearchEngine.targetSites)
 * ## Example Usage
 * ### Discoveryengine Targetsite Basic
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const basicDataStore = new gcp.discoveryengine.DataStore("basic", {
 *     location: "global",
 *     dataStoreId: "data-store-id",
 *     displayName: "tf-test-basic-site-search-datastore",
 *     industryVertical: "GENERIC",
 *     contentConfig: "PUBLIC_WEBSITE",
 *     solutionTypes: ["SOLUTION_TYPE_SEARCH"],
 *     createAdvancedSiteSearch: false,
 *     skipDefaultSchemaCreation: false,
 * });
 * const basic = new gcp.discoveryengine.TargetSite("basic", {
 *     location: basicDataStore.location,
 *     dataStoreId: basicDataStore.dataStoreId,
 *     providedUriPattern: "http://cloud.google.com/docs/*",
 *     type: "INCLUDE",
 *     exactMatch: false,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * basic_data_store = gcp.discoveryengine.DataStore("basic",
 *     location="global",
 *     data_store_id="data-store-id",
 *     display_name="tf-test-basic-site-search-datastore",
 *     industry_vertical="GENERIC",
 *     content_config="PUBLIC_WEBSITE",
 *     solution_types=["SOLUTION_TYPE_SEARCH"],
 *     create_advanced_site_search=False,
 *     skip_default_schema_creation=False)
 * basic = gcp.discoveryengine.TargetSite("basic",
 *     location=basic_data_store.location,
 *     data_store_id=basic_data_store.data_store_id,
 *     provided_uri_pattern="http://cloud.google.com/docs/*",
 *     type="INCLUDE",
 *     exact_match=False)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var basicDataStore = new Gcp.DiscoveryEngine.DataStore("basic", new()
 *     {
 *         Location = "global",
 *         DataStoreId = "data-store-id",
 *         DisplayName = "tf-test-basic-site-search-datastore",
 *         IndustryVertical = "GENERIC",
 *         ContentConfig = "PUBLIC_WEBSITE",
 *         SolutionTypes = new[]
 *         {
 *             "SOLUTION_TYPE_SEARCH",
 *         },
 *         CreateAdvancedSiteSearch = false,
 *         SkipDefaultSchemaCreation = false,
 *     });
 *     var basic = new Gcp.DiscoveryEngine.TargetSite("basic", new()
 *     {
 *         Location = basicDataStore.Location,
 *         DataStoreId = basicDataStore.DataStoreId,
 *         ProvidedUriPattern = "http://cloud.google.com/docs/*",
 *         Type = "INCLUDE",
 *         ExactMatch = false,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/discoveryengine"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		basicDataStore, err := discoveryengine.NewDataStore(ctx, "basic", &discoveryengine.DataStoreArgs{
 * 			Location:         pulumi.String("global"),
 * 			DataStoreId:      pulumi.String("data-store-id"),
 * 			DisplayName:      pulumi.String("tf-test-basic-site-search-datastore"),
 * 			IndustryVertical: pulumi.String("GENERIC"),
 * 			ContentConfig:    pulumi.String("PUBLIC_WEBSITE"),
 * 			SolutionTypes: pulumi.StringArray{
 * 				pulumi.String("SOLUTION_TYPE_SEARCH"),
 * 			},
 * 			CreateAdvancedSiteSearch:  pulumi.Bool(false),
 * 			SkipDefaultSchemaCreation: pulumi.Bool(false),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = discoveryengine.NewTargetSite(ctx, "basic", &discoveryengine.TargetSiteArgs{
 * 			Location:           basicDataStore.Location,
 * 			DataStoreId:        basicDataStore.DataStoreId,
 * 			ProvidedUriPattern: pulumi.String("http://cloud.google.com/docs/*"),
 * 			Type:               pulumi.String("INCLUDE"),
 * 			ExactMatch:         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 com.pulumi.gcp.discoveryengine.TargetSite;
 * import com.pulumi.gcp.discoveryengine.TargetSiteArgs;
 * 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 basicDataStore = new DataStore("basicDataStore", DataStoreArgs.builder()
 *             .location("global")
 *             .dataStoreId("data-store-id")
 *             .displayName("tf-test-basic-site-search-datastore")
 *             .industryVertical("GENERIC")
 *             .contentConfig("PUBLIC_WEBSITE")
 *             .solutionTypes("SOLUTION_TYPE_SEARCH")
 *             .createAdvancedSiteSearch(false)
 *             .skipDefaultSchemaCreation(false)
 *             .build());
 *         var basic = new TargetSite("basic", TargetSiteArgs.builder()
 *             .location(basicDataStore.location())
 *             .dataStoreId(basicDataStore.dataStoreId())
 *             .providedUriPattern("http://cloud.google.com/docs/*")
 *             .type("INCLUDE")
 *             .exactMatch(false)
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   basic:
 *     type: gcp:discoveryengine:TargetSite
 *     properties:
 *       location: ${basicDataStore.location}
 *       dataStoreId: ${basicDataStore.dataStoreId}
 *       providedUriPattern: http://cloud.google.com/docs/*
 *       type: INCLUDE
 *       exactMatch: false
 *   basicDataStore:
 *     type: gcp:discoveryengine:DataStore
 *     name: basic
 *     properties:
 *       location: global
 *       dataStoreId: data-store-id
 *       displayName: tf-test-basic-site-search-datastore
 *       industryVertical: GENERIC
 *       contentConfig: PUBLIC_WEBSITE
 *       solutionTypes:
 *         - SOLUTION_TYPE_SEARCH
 *       createAdvancedSiteSearch: false
 *       skipDefaultSchemaCreation: false
 * ```
 * 
 * ### Discoveryengine Targetsite Advanced
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const advancedDataStore = new gcp.discoveryengine.DataStore("advanced", {
 *     location: "global",
 *     dataStoreId: "data-store-id",
 *     displayName: "tf-test-advanced-site-search-datastore",
 *     industryVertical: "GENERIC",
 *     contentConfig: "PUBLIC_WEBSITE",
 *     solutionTypes: ["SOLUTION_TYPE_SEARCH"],
 *     createAdvancedSiteSearch: true,
 *     skipDefaultSchemaCreation: false,
 * });
 * const advanced = new gcp.discoveryengine.TargetSite("advanced", {
 *     location: advancedDataStore.location,
 *     dataStoreId: advancedDataStore.dataStoreId,
 *     providedUriPattern: "http://cloud.google.com/docs/*",
 *     type: "INCLUDE",
 *     exactMatch: false,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * advanced_data_store = gcp.discoveryengine.DataStore("advanced",
 *     location="global",
 *     data_store_id="data-store-id",
 *     display_name="tf-test-advanced-site-search-datastore",
 *     industry_vertical="GENERIC",
 *     content_config="PUBLIC_WEBSITE",
 *     solution_types=["SOLUTION_TYPE_SEARCH"],
 *     create_advanced_site_search=True,
 *     skip_default_schema_creation=False)
 * advanced = gcp.discoveryengine.TargetSite("advanced",
 *     location=advanced_data_store.location,
 *     data_store_id=advanced_data_store.data_store_id,
 *     provided_uri_pattern="http://cloud.google.com/docs/*",
 *     type="INCLUDE",
 *     exact_match=False)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var advancedDataStore = new Gcp.DiscoveryEngine.DataStore("advanced", new()
 *     {
 *         Location = "global",
 *         DataStoreId = "data-store-id",
 *         DisplayName = "tf-test-advanced-site-search-datastore",
 *         IndustryVertical = "GENERIC",
 *         ContentConfig = "PUBLIC_WEBSITE",
 *         SolutionTypes = new[]
 *         {
 *             "SOLUTION_TYPE_SEARCH",
 *         },
 *         CreateAdvancedSiteSearch = true,
 *         SkipDefaultSchemaCreation = false,
 *     });
 *     var advanced = new Gcp.DiscoveryEngine.TargetSite("advanced", new()
 *     {
 *         Location = advancedDataStore.Location,
 *         DataStoreId = advancedDataStore.DataStoreId,
 *         ProvidedUriPattern = "http://cloud.google.com/docs/*",
 *         Type = "INCLUDE",
 *         ExactMatch = false,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/discoveryengine"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		advancedDataStore, err := discoveryengine.NewDataStore(ctx, "advanced", &discoveryengine.DataStoreArgs{
 * 			Location:         pulumi.String("global"),
 * 			DataStoreId:      pulumi.String("data-store-id"),
 * 			DisplayName:      pulumi.String("tf-test-advanced-site-search-datastore"),
 * 			IndustryVertical: pulumi.String("GENERIC"),
 * 			ContentConfig:    pulumi.String("PUBLIC_WEBSITE"),
 * 			SolutionTypes: pulumi.StringArray{
 * 				pulumi.String("SOLUTION_TYPE_SEARCH"),
 * 			},
 * 			CreateAdvancedSiteSearch:  pulumi.Bool(true),
 * 			SkipDefaultSchemaCreation: pulumi.Bool(false),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = discoveryengine.NewTargetSite(ctx, "advanced", &discoveryengine.TargetSiteArgs{
 * 			Location:           advancedDataStore.Location,
 * 			DataStoreId:        advancedDataStore.DataStoreId,
 * 			ProvidedUriPattern: pulumi.String("http://cloud.google.com/docs/*"),
 * 			Type:               pulumi.String("INCLUDE"),
 * 			ExactMatch:         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 com.pulumi.gcp.discoveryengine.TargetSite;
 * import com.pulumi.gcp.discoveryengine.TargetSiteArgs;
 * 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 advancedDataStore = new DataStore("advancedDataStore", DataStoreArgs.builder()
 *             .location("global")
 *             .dataStoreId("data-store-id")
 *             .displayName("tf-test-advanced-site-search-datastore")
 *             .industryVertical("GENERIC")
 *             .contentConfig("PUBLIC_WEBSITE")
 *             .solutionTypes("SOLUTION_TYPE_SEARCH")
 *             .createAdvancedSiteSearch(true)
 *             .skipDefaultSchemaCreation(false)
 *             .build());
 *         var advanced = new TargetSite("advanced", TargetSiteArgs.builder()
 *             .location(advancedDataStore.location())
 *             .dataStoreId(advancedDataStore.dataStoreId())
 *             .providedUriPattern("http://cloud.google.com/docs/*")
 *             .type("INCLUDE")
 *             .exactMatch(false)
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   advanced:
 *     type: gcp:discoveryengine:TargetSite
 *     properties:
 *       location: ${advancedDataStore.location}
 *       dataStoreId: ${advancedDataStore.dataStoreId}
 *       providedUriPattern: http://cloud.google.com/docs/*
 *       type: INCLUDE
 *       exactMatch: false
 *   advancedDataStore:
 *     type: gcp:discoveryengine:DataStore
 *     name: advanced
 *     properties:
 *       location: global
 *       dataStoreId: data-store-id
 *       displayName: tf-test-advanced-site-search-datastore
 *       industryVertical: GENERIC
 *       contentConfig: PUBLIC_WEBSITE
 *       solutionTypes:
 *         - SOLUTION_TYPE_SEARCH
 *       createAdvancedSiteSearch: true
 *       skipDefaultSchemaCreation: false
 * ```
 * 
 * ## Import
 * TargetSite can be imported using any of these accepted formats:
 * * `projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}/siteSearchEngine/targetSites/{{target_site_id}}`
 * * `{{project}}/{{location}}/{{data_store_id}}/{{target_site_id}}`
 * * `{{location}}/{{data_store_id}}/{{target_site_id}}`
 * When using the `pulumi import` command, TargetSite can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:discoveryengine/targetSite:TargetSite default projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}/siteSearchEngine/targetSites/{{target_site_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:discoveryengine/targetSite:TargetSite default {{project}}/{{location}}/{{data_store_id}}/{{target_site_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:discoveryengine/targetSite:TargetSite default {{location}}/{{data_store_id}}/{{target_site_id}}
 * ```
 * @property dataStoreId The unique id of the data store.
 * - - -
 * @property exactMatch If set to false, a uri_pattern is generated to include all pages whose
 * address contains the provided_uri_pattern. If set to true, an uri_pattern
 * is generated to try to be an exact match of the provided_uri_pattern or
 * just the specific page if the provided_uri_pattern is a specific one.
 * provided_uri_pattern is always normalized to generate the URI pattern to
 * be used by the search engine.
 * @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 providedUriPattern The user provided URI pattern from which the `generated_uri_pattern` is
 * generated.
 * @property type The possible target site types.
 * Possible values are: `INCLUDE`, `EXCLUDE`.
 * */*/*/*/*/*/*/*/*/*/*/*/
 */
public data class TargetSiteArgs(
    public val dataStoreId: Output? = null,
    public val exactMatch: Output? = null,
    public val location: Output? = null,
    public val project: Output? = null,
    public val providedUriPattern: Output? = null,
    public val type: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.discoveryengine.TargetSiteArgs =
        com.pulumi.gcp.discoveryengine.TargetSiteArgs.builder()
            .dataStoreId(dataStoreId?.applyValue({ args0 -> args0 }))
            .exactMatch(exactMatch?.applyValue({ args0 -> args0 }))
            .location(location?.applyValue({ args0 -> args0 }))
            .project(project?.applyValue({ args0 -> args0 }))
            .providedUriPattern(providedUriPattern?.applyValue({ args0 -> args0 }))
            .type(type?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [TargetSiteArgs].
 */
@PulumiTagMarker
public class TargetSiteArgsBuilder internal constructor() {
    private var dataStoreId: Output? = null

    private var exactMatch: Output? = null

    private var location: Output? = null

    private var project: Output? = null

    private var providedUriPattern: Output? = null

    private var type: Output? = null

    /**
     * @param value The unique id of the data store.
     * - - -
     */
    @JvmName("klnoslrjtcpecmbe")
    public suspend fun dataStoreId(`value`: Output) {
        this.dataStoreId = value
    }

    /**
     * @param value If set to false, a uri_pattern is generated to include all pages whose
     * address contains the provided_uri_pattern. If set to true, an uri_pattern
     * is generated to try to be an exact match of the provided_uri_pattern or
     * just the specific page if the provided_uri_pattern is a specific one.
     * provided_uri_pattern is always normalized to generate the URI pattern to
     * be used by the search engine.
     */
    @JvmName("sfqrmbiwbunxoebw")
    public suspend fun exactMatch(`value`: Output) {
        this.exactMatch = value
    }

    /**
     * @param value The geographic location where the data store should reside. The value can
     * only be one of "global", "us" and "eu".
     */
    @JvmName("bgcbsyfyovkvsbhi")
    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("fdrhgtpitxfpgocx")
    public suspend fun project(`value`: Output) {
        this.project = value
    }

    /**
     * @param value The user provided URI pattern from which the `generated_uri_pattern` is
     * generated.
     */
    @JvmName("wedgiglnjpphtcjp")
    public suspend fun providedUriPattern(`value`: Output) {
        this.providedUriPattern = value
    }

    /**
     * @param value The possible target site types.
     * Possible values are: `INCLUDE`, `EXCLUDE`.
     */
    @JvmName("bqcfotgneuwwwgwh")
    public suspend fun type(`value`: Output) {
        this.type = value
    }

    /**
     * @param value The unique id of the data store.
     * - - -
     */
    @JvmName("jbsoaohotkwrnehp")
    public suspend fun dataStoreId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.dataStoreId = mapped
    }

    /**
     * @param value If set to false, a uri_pattern is generated to include all pages whose
     * address contains the provided_uri_pattern. If set to true, an uri_pattern
     * is generated to try to be an exact match of the provided_uri_pattern or
     * just the specific page if the provided_uri_pattern is a specific one.
     * provided_uri_pattern is always normalized to generate the URI pattern to
     * be used by the search engine.
     */
    @JvmName("qmihrtjnimkpefwd")
    public suspend fun exactMatch(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.exactMatch = mapped
    }

    /**
     * @param value The geographic location where the data store should reside. The value can
     * only be one of "global", "us" and "eu".
     */
    @JvmName("debrlrswymstsonw")
    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("melgfulalutqowkh")
    public suspend fun project(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.project = mapped
    }

    /**
     * @param value The user provided URI pattern from which the `generated_uri_pattern` is
     * generated.
     */
    @JvmName("ipfmkiatpqwbejms")
    public suspend fun providedUriPattern(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.providedUriPattern = mapped
    }

    /**
     * @param value The possible target site types.
     * Possible values are: `INCLUDE`, `EXCLUDE`.
     */
    @JvmName("letjfbetdisffmvd")
    public suspend fun type(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.type = mapped
    }

    internal fun build(): TargetSiteArgs = TargetSiteArgs(
        dataStoreId = dataStoreId,
        exactMatch = exactMatch,
        location = location,
        project = project,
        providedUriPattern = providedUriPattern,
        type = type,
    )
}