Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. discoveryengine
  5. TargetSite
Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.discoveryengine.TargetSite

Explore with Pulumi AI

gcp logo
Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-gcp

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

    To get more information about TargetSite, see:

    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)

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

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

return await Deployment.RunAsync(() => 
{
    var 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 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("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)

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

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

return await Deployment.RunAsync(() => 
{
    var 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 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("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

    Create TargetSite Resource

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

    Constructor syntax

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

@overload
def TargetSite(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               data_store_id: Optional[str] = None,
               location: Optional[str] = None,
               provided_uri_pattern: Optional[str] = None,
               exact_match: Optional[bool] = None,
               project: Optional[str] = None,
               type: Optional[str] = None)
    func NewTargetSite(ctx *Context, name string, args TargetSiteArgs, opts ...ResourceOption) (*TargetSite, error)
    public TargetSite(string name, TargetSiteArgs args, CustomResourceOptions? opts = null)
    public TargetSite(String name, TargetSiteArgs args)
public TargetSite(String name, TargetSiteArgs args, CustomResourceOptions options)

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

    Parameters

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

    Constructor example

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

    var targetSiteResource = new Gcp.DiscoveryEngine.TargetSite("targetSiteResource", new()
{
    DataStoreId = "string",
    Location = "string",
    ProvidedUriPattern = "string",
    ExactMatch = false,
    Project = "string",
    Type = "string",
});

    example, err := discoveryengine.NewTargetSite(ctx, "targetSiteResource", &discoveryengine.TargetSiteArgs{
	DataStoreId:        pulumi.String("string"),
	Location:           pulumi.String("string"),
	ProvidedUriPattern: pulumi.String("string"),
	ExactMatch:         pulumi.Bool(false),
	Project:            pulumi.String("string"),
	Type:               pulumi.String("string"),
})

    var targetSiteResource = new TargetSite("targetSiteResource", TargetSiteArgs.builder()
    .dataStoreId("string")
    .location("string")
    .providedUriPattern("string")
    .exactMatch(false)
    .project("string")
    .type("string")
    .build());

    target_site_resource = gcp.discoveryengine.TargetSite("targetSiteResource",
    data_store_id="string",
    location="string",
    provided_uri_pattern="string",
    exact_match=False,
    project="string",
    type="string")

    const targetSiteResource = new gcp.discoveryengine.TargetSite("targetSiteResource", {
    dataStoreId: "string",
    location: "string",
    providedUriPattern: "string",
    exactMatch: false,
    project: "string",
    type: "string",
});

    type: gcp:discoveryengine:TargetSite
properties:
    dataStoreId: string
    exactMatch: false
    location: string
    project: string
    providedUriPattern: string
    type: string

    TargetSite Resource Properties

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

    Inputs

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

    The TargetSite resource accepts the following input properties:

    DataStoreId string
    The unique id of the data store.

    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    ProvidedUriPattern string
    The user provided URI pattern from which the generated_uri_pattern is generated.
    ExactMatch bool
    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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Type string
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    DataStoreId string
    The unique id of the data store.

    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    ProvidedUriPattern string
    The user provided URI pattern from which the generated_uri_pattern is generated.
    ExactMatch bool
    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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Type string
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    dataStoreId String
    The unique id of the data store.

    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    providedUriPattern String
    The user provided URI pattern from which the generated_uri_pattern is generated.
    exactMatch Boolean
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    type String
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    dataStoreId string
    The unique id of the data store.

    location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    providedUriPattern string
    The user provided URI pattern from which the generated_uri_pattern is generated.
    exactMatch boolean
    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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    type string
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    data_store_id str
    The unique id of the data store.

    location str
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    provided_uri_pattern str
    The user provided URI pattern from which the generated_uri_pattern is generated.
    exact_match bool
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    type str
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    dataStoreId String
    The unique id of the data store.

    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    providedUriPattern String
    The user provided URI pattern from which the generated_uri_pattern is generated.
    exactMatch Boolean
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    type String
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.

    Outputs

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

    FailureReasons List<TargetSiteFailureReason>
    Site search indexing failure reasons. Structure is documented below.
    GeneratedUriPattern string
    This is system-generated based on the provided_uri_pattern.
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexingStatus string
    The indexing status.
    Name 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.
    RootDomainUri string
    Root domain of the provided_uri_pattern.
    SiteVerificationInfos List<TargetSiteSiteVerificationInfo>
    Site ownership and validity verification status. Structure is documented below.
    TargetSiteId string
    The unique id of the target site.
    UpdateTime string
    The target site's last updated time.
    FailureReasons []TargetSiteFailureReason
    Site search indexing failure reasons. Structure is documented below.
    GeneratedUriPattern string
    This is system-generated based on the provided_uri_pattern.
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexingStatus string
    The indexing status.
    Name 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.
    RootDomainUri string
    Root domain of the provided_uri_pattern.
    SiteVerificationInfos []TargetSiteSiteVerificationInfo
    Site ownership and validity verification status. Structure is documented below.
    TargetSiteId string
    The unique id of the target site.
    UpdateTime string
    The target site's last updated time.
    failureReasons List<TargetSiteFailureReason>
    Site search indexing failure reasons. Structure is documented below.
    generatedUriPattern String
    This is system-generated based on the provided_uri_pattern.
    id String
    The provider-assigned unique ID for this managed resource.
    indexingStatus String
    The indexing status.
    name 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.
    rootDomainUri String
    Root domain of the provided_uri_pattern.
    siteVerificationInfos List<TargetSiteSiteVerificationInfo>
    Site ownership and validity verification status. Structure is documented below.
    targetSiteId String
    The unique id of the target site.
    updateTime String
    The target site's last updated time.
    failureReasons TargetSiteFailureReason[]
    Site search indexing failure reasons. Structure is documented below.
    generatedUriPattern string
    This is system-generated based on the provided_uri_pattern.
    id string
    The provider-assigned unique ID for this managed resource.
    indexingStatus string
    The indexing status.
    name 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.
    rootDomainUri string
    Root domain of the provided_uri_pattern.
    siteVerificationInfos TargetSiteSiteVerificationInfo[]
    Site ownership and validity verification status. Structure is documented below.
    targetSiteId string
    The unique id of the target site.
    updateTime string
    The target site's last updated time.
    failure_reasons Sequence[TargetSiteFailureReason]
    Site search indexing failure reasons. Structure is documented below.
    generated_uri_pattern str
    This is system-generated based on the provided_uri_pattern.
    id str
    The provider-assigned unique ID for this managed resource.
    indexing_status str
    The indexing status.
    name str
    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.
    root_domain_uri str
    Root domain of the provided_uri_pattern.
    site_verification_infos Sequence[TargetSiteSiteVerificationInfo]
    Site ownership and validity verification status. Structure is documented below.
    target_site_id str
    The unique id of the target site.
    update_time str
    The target site's last updated time.
    failureReasons List<Property Map>
    Site search indexing failure reasons. Structure is documented below.
    generatedUriPattern String
    This is system-generated based on the provided_uri_pattern.
    id String
    The provider-assigned unique ID for this managed resource.
    indexingStatus String
    The indexing status.
    name 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.
    rootDomainUri String
    Root domain of the provided_uri_pattern.
    siteVerificationInfos List<Property Map>
    Site ownership and validity verification status. Structure is documented below.
    targetSiteId String
    The unique id of the target site.
    updateTime String
    The target site's last updated time.

    Look up Existing TargetSite Resource

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

    public static get(name: string, id: Input<ID>, state?: TargetSiteState, opts?: CustomResourceOptions): TargetSite
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_store_id: Optional[str] = None,
        exact_match: Optional[bool] = None,
        failure_reasons: Optional[Sequence[TargetSiteFailureReasonArgs]] = None,
        generated_uri_pattern: Optional[str] = None,
        indexing_status: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        provided_uri_pattern: Optional[str] = None,
        root_domain_uri: Optional[str] = None,
        site_verification_infos: Optional[Sequence[TargetSiteSiteVerificationInfoArgs]] = None,
        target_site_id: Optional[str] = None,
        type: Optional[str] = None,
        update_time: Optional[str] = None) -> TargetSite
    func GetTargetSite(ctx *Context, name string, id IDInput, state *TargetSiteState, opts ...ResourceOption) (*TargetSite, error)
    public static TargetSite Get(string name, Input<string> id, TargetSiteState? state, CustomResourceOptions? opts = null)
    public static TargetSite get(String name, Output<String> id, TargetSiteState state, CustomResourceOptions options)
    resources:  _:    type: gcp:discoveryengine:TargetSite    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DataStoreId string
    The unique id of the data store.

    ExactMatch bool
    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.
    FailureReasons List<TargetSiteFailureReason>
    Site search indexing failure reasons. Structure is documented below.
    GeneratedUriPattern string
    This is system-generated based on the provided_uri_pattern.
    IndexingStatus string
    The indexing status.
    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    Name 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ProvidedUriPattern string
    The user provided URI pattern from which the generated_uri_pattern is generated.
    RootDomainUri string
    Root domain of the provided_uri_pattern.
    SiteVerificationInfos List<TargetSiteSiteVerificationInfo>
    Site ownership and validity verification status. Structure is documented below.
    TargetSiteId string
    The unique id of the target site.
    Type string
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    UpdateTime string
    The target site's last updated time.
    DataStoreId string
    The unique id of the data store.

    ExactMatch bool
    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.
    FailureReasons []TargetSiteFailureReasonArgs
    Site search indexing failure reasons. Structure is documented below.
    GeneratedUriPattern string
    This is system-generated based on the provided_uri_pattern.
    IndexingStatus string
    The indexing status.
    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    Name 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ProvidedUriPattern string
    The user provided URI pattern from which the generated_uri_pattern is generated.
    RootDomainUri string
    Root domain of the provided_uri_pattern.
    SiteVerificationInfos []TargetSiteSiteVerificationInfoArgs
    Site ownership and validity verification status. Structure is documented below.
    TargetSiteId string
    The unique id of the target site.
    Type string
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    UpdateTime string
    The target site's last updated time.
    dataStoreId String
    The unique id of the data store.

    exactMatch Boolean
    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.
    failureReasons List<TargetSiteFailureReason>
    Site search indexing failure reasons. Structure is documented below.
    generatedUriPattern String
    This is system-generated based on the provided_uri_pattern.
    indexingStatus String
    The indexing status.
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    providedUriPattern String
    The user provided URI pattern from which the generated_uri_pattern is generated.
    rootDomainUri String
    Root domain of the provided_uri_pattern.
    siteVerificationInfos List<TargetSiteSiteVerificationInfo>
    Site ownership and validity verification status. Structure is documented below.
    targetSiteId String
    The unique id of the target site.
    type String
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    updateTime String
    The target site's last updated time.
    dataStoreId string
    The unique id of the data store.

    exactMatch boolean
    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.
    failureReasons TargetSiteFailureReason[]
    Site search indexing failure reasons. Structure is documented below.
    generatedUriPattern string
    This is system-generated based on the provided_uri_pattern.
    indexingStatus string
    The indexing status.
    location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name 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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    providedUriPattern string
    The user provided URI pattern from which the generated_uri_pattern is generated.
    rootDomainUri string
    Root domain of the provided_uri_pattern.
    siteVerificationInfos TargetSiteSiteVerificationInfo[]
    Site ownership and validity verification status. Structure is documented below.
    targetSiteId string
    The unique id of the target site.
    type string
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    updateTime string
    The target site's last updated time.
    data_store_id str
    The unique id of the data store.

    exact_match bool
    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.
    failure_reasons Sequence[TargetSiteFailureReasonArgs]
    Site search indexing failure reasons. Structure is documented below.
    generated_uri_pattern str
    This is system-generated based on the provided_uri_pattern.
    indexing_status str
    The indexing status.
    location str
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name str
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    provided_uri_pattern str
    The user provided URI pattern from which the generated_uri_pattern is generated.
    root_domain_uri str
    Root domain of the provided_uri_pattern.
    site_verification_infos Sequence[TargetSiteSiteVerificationInfoArgs]
    Site ownership and validity verification status. Structure is documented below.
    target_site_id str
    The unique id of the target site.
    type str
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    update_time str
    The target site's last updated time.
    dataStoreId String
    The unique id of the data store.

    exactMatch Boolean
    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.
    failureReasons List<Property Map>
    Site search indexing failure reasons. Structure is documented below.
    generatedUriPattern String
    This is system-generated based on the provided_uri_pattern.
    indexingStatus String
    The indexing status.
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    providedUriPattern String
    The user provided URI pattern from which the generated_uri_pattern is generated.
    rootDomainUri String
    Root domain of the provided_uri_pattern.
    siteVerificationInfos List<Property Map>
    Site ownership and validity verification status. Structure is documented below.
    targetSiteId String
    The unique id of the target site.
    type String
    The possible target site types. Possible values are: INCLUDE, EXCLUDE.
    updateTime String
    The target site's last updated time.

    Supporting Types

    TargetSiteFailureReason, TargetSiteFailureReasonArgs

    QuotaFailure TargetSiteFailureReasonQuotaFailure
    Site verification state indicating the ownership and validity. Structure is documented below.
    QuotaFailure TargetSiteFailureReasonQuotaFailure
    Site verification state indicating the ownership and validity. Structure is documented below.
    quotaFailure TargetSiteFailureReasonQuotaFailure
    Site verification state indicating the ownership and validity. Structure is documented below.
    quotaFailure TargetSiteFailureReasonQuotaFailure
    Site verification state indicating the ownership and validity. Structure is documented below.
    quota_failure TargetSiteFailureReasonQuotaFailure
    Site verification state indicating the ownership and validity. Structure is documented below.
    quotaFailure Property Map
    Site verification state indicating the ownership and validity. Structure is documented below.

    TargetSiteFailureReasonQuotaFailure, TargetSiteFailureReasonQuotaFailureArgs

    TotalRequiredQuota int
    This number is an estimation on how much total quota this project needs to successfully complete indexing.
    TotalRequiredQuota int
    This number is an estimation on how much total quota this project needs to successfully complete indexing.
    totalRequiredQuota Integer
    This number is an estimation on how much total quota this project needs to successfully complete indexing.
    totalRequiredQuota number
    This number is an estimation on how much total quota this project needs to successfully complete indexing.
    total_required_quota int
    This number is an estimation on how much total quota this project needs to successfully complete indexing.
    totalRequiredQuota Number
    This number is an estimation on how much total quota this project needs to successfully complete indexing.

    TargetSiteSiteVerificationInfo, TargetSiteSiteVerificationInfoArgs

    SiteVerificationState string
    Site verification state indicating the ownership and validity. Possible values are: VERIFIED, UNVERIFIED, EXEMPTED.
    VerifyTime string
    Latest site verification time.
    SiteVerificationState string
    Site verification state indicating the ownership and validity. Possible values are: VERIFIED, UNVERIFIED, EXEMPTED.
    VerifyTime string
    Latest site verification time.
    siteVerificationState String
    Site verification state indicating the ownership and validity. Possible values are: VERIFIED, UNVERIFIED, EXEMPTED.
    verifyTime String
    Latest site verification time.
    siteVerificationState string
    Site verification state indicating the ownership and validity. Possible values are: VERIFIED, UNVERIFIED, EXEMPTED.
    verifyTime string
    Latest site verification time.
    site_verification_state str
    Site verification state indicating the ownership and validity. Possible values are: VERIFIED, UNVERIFIED, EXEMPTED.
    verify_time str
    Latest site verification time.
    siteVerificationState String
    Site verification state indicating the ownership and validity. Possible values are: VERIFIED, UNVERIFIED, EXEMPTED.
    verifyTime String
    Latest site verification time.

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

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-gcp