@pulumi/gcp/discoveryengine/sitemap.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Sitemap is a file where you provide information about the pages, videos, and
 * other files on your site, and the relationships between them.
 *
 * To get more information about Sitemap, see:
 *
 * * [API documentation](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.dataStores.siteSearchEngine.sitemaps)
 *
 * ## Example Usage
 *
 * ### Discoveryengine Sitemap Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const advanced = 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 basic = new gcp.discoveryengine.Sitemap("basic", {
 *     location: advanced.location,
 *     dataStoreId: advanced.dataStoreId,
 *     uri: "https://www.test.com/sitemap.xml",
 * });
 * ```
 *
 * ## Import
 *
 * Sitemap can be imported using any of these accepted formats:
 *
 * * `{{name}}`
 *
 * When using the `pulumi import` command, Sitemap can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:discoveryengine/sitemap:Sitemap default {{name}}
 * ```
 */
export declare class Sitemap extends pulumi.CustomResource {
    /**
     * Get an existing Sitemap resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SitemapState, opts?: pulumi.CustomResourceOptions): Sitemap;
    /**
     * Returns true if the given object is an instance of Sitemap.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Sitemap;
    /**
     * Timestamp when the sitemap was created.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * The unique id of the data store.
     */
    readonly dataStoreId: pulumi.Output<string>;
    /**
     * The geographic location where the data store should reside. The value can
     * only be one of "global", "us" and "eu".
     */
    readonly location: pulumi.Output<string>;
    /**
     * The unique full resource name of the sitemap. Values are of the format
     * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/siteSearchEngine/sitemaps/{sitemap_id}`.
     * This field must be a UTF-8 encoded string with a length limit of 1024
     * characters.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The unique id of the sitemap.
     */
    readonly sitemapId: pulumi.Output<string>;
    /**
     * Public URI for the sitemap, e.g. "www.example.com/sitemap.xml".
     */
    readonly uri: pulumi.Output<string | undefined>;
    /**
     * Create a Sitemap resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: SitemapArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Sitemap resources.
 */
export interface SitemapState {
    /**
     * Timestamp when the sitemap was created.
     */
    createTime?: pulumi.Input<string>;
    /**
     * The unique id of the data store.
     */
    dataStoreId?: pulumi.Input<string>;
    /**
     * The geographic location where the data store should reside. The value can
     * only be one of "global", "us" and "eu".
     */
    location?: pulumi.Input<string>;
    /**
     * The unique full resource name of the sitemap. Values are of the format
     * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/siteSearchEngine/sitemaps/{sitemap_id}`.
     * This field must be a UTF-8 encoded string with a length limit of 1024
     * characters.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The unique id of the sitemap.
     */
    sitemapId?: pulumi.Input<string>;
    /**
     * Public URI for the sitemap, e.g. "www.example.com/sitemap.xml".
     */
    uri?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Sitemap resource.
 */
export interface SitemapArgs {
    /**
     * The unique id of the data store.
     */
    dataStoreId: pulumi.Input<string>;
    /**
     * The geographic location where the data store should reside. The value can
     * only be one of "global", "us" and "eu".
     */
    location: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * Public URI for the sitemap, e.g. "www.example.com/sitemap.xml".
     */
    uri?: pulumi.Input<string>;
}