TargetSite class

TargetSite represents a URI pattern that the users want to confine their search.

To get more information about TargetSite, see:

API documentation

Example Usage

Discoveryengine Targetsite Basic

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: "cloud.google.com/docs/*",
    type: "INCLUDE",
    exactMatch: false,
});

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="cloud.google.com/docs/*",
    type="INCLUDE",
    exact_match=False)

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 = "cloud.google.com/docs/*",
        Type = "INCLUDE",
        ExactMatch = false,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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("cloud.google.com/docs/*"),
			Type:               pulumi.String("INCLUDE"),
			ExactMatch:         pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_discoveryengine_targetsite" "basic" {
  location             = gcp_discoveryengine_datastore.basic.location
  data_store_id        = gcp_discoveryengine_datastore.basic.data_store_id
  provided_uri_pattern = "cloud.google.com/docs/*"
  type                 = "INCLUDE"
  exact_match          = false
}
resource "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
}

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.ArrayList;
import java.util.Arrays;
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("cloud.google.com/docs/*")
            .type("INCLUDE")
            .exactMatch(false)
            .build());

    }
}

resources:
  basic:
    type: gcp:discoveryengine:TargetSite
    properties:
      location: ${basicDataStore.location}
      dataStoreId: ${basicDataStore.dataStoreId}
      providedUriPattern: 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

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: "cloud.google.com/docs/*",
    type: "INCLUDE",
    exactMatch: false,
});

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="cloud.google.com/docs/*",
    type="INCLUDE",
    exact_match=False)

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 = "cloud.google.com/docs/*",
        Type = "INCLUDE",
        ExactMatch = false,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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("cloud.google.com/docs/*"),
			Type:               pulumi.String("INCLUDE"),
			ExactMatch:         pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_discoveryengine_targetsite" "advanced" {
  location             = gcp_discoveryengine_datastore.advanced.location
  data_store_id        = gcp_discoveryengine_datastore.advanced.data_store_id
  provided_uri_pattern = "cloud.google.com/docs/*"
  type                 = "INCLUDE"
  exact_match          = false
}
resource "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
}

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.ArrayList;
import java.util.Arrays;
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("cloud.google.com/docs/*")
            .type("INCLUDE")
            .exactMatch(false)
            .build());

    }
}

resources:
  advanced:
    type: gcp:discoveryengine:TargetSite
    properties:
      location: ${advancedDataStore.location}
      dataStoreId: ${advancedDataStore.dataStoreId}
      providedUriPattern: 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:

$ pulumi import gcp:discoveryengine/targetSite:TargetSite default projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}/siteSearchEngine/targetSites/{{target_site_id}}
$ pulumi import gcp:discoveryengine/targetSite:TargetSite default {{project}}/{{location}}/{{data_store_id}}/{{target_site_id}}
$ pulumi import gcp:discoveryengine/targetSite:TargetSite default {{location}}/{{data_store_id}}/{{target_site_id}}

Constructors

TargetSite(String name, {TargetSiteArgs? args, CustomResourceOptions? options}): Creates a new TargetSite. name The Pulumi resource name. args Arguments used to configure this TargetSite. The set of arguments for TargetSite. options Resource options controlling this resource's behavior.
TargetSite.reference(String urn): Creates a typed reference to an existing TargetSite resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
dataStoreId ↔ Output<String>: The unique id of the data store.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
exactMatch ↔ Output<bool?>: If set to false, a uriPattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uriPattern is generated to try to be an exact match of the providedUriPattern or just the specific page if the providedUriPattern is a specific one. providedUriPattern is always normalized to generate the URI pattern to be used by the search engine.
latefinal
failureReasons ↔ Output<List<TargetSiteFailureReason>>: Site search indexing failure reasons. Structure is documented below.
latefinal
generatedUriPattern ↔ Output<String>: This is system-generated based on the providedUriPattern.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
indexingStatus ↔ Output<String>: The indexing status.
latefinal
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ Output<String>: The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
latefinal
name ↔ Output<String>: The unique full resource name of the target site. Values are of the format projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/siteSearchEngine/targetSites/{target_site_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
providedUriPattern ↔ Output<String>: The user provided URI pattern from which the generatedUriPattern is generated.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
rootDomainUri ↔ Output<String>: Root domain of the providedUriPattern.
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
siteVerificationInfos ↔ Output<List<TargetSiteSiteVerificationInfo>>: Site ownership and validity verification status. Structure is documented below.
latefinal
targetSiteId ↔ Output<String>: The unique id of the target site.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String?>: The possible target site types. Possible values are: INCLUDE, EXCLUDE.
latefinal
updateTime ↔ Output<String>: The target site's last updated time.
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {TargetSiteState? state, CustomResourceOptions? options}) → TargetSite: Gets an existing TargetSite resource's state with the given name and id.