@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
127 lines • 5.24 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Schema = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Schema defines the structure and layout of a type of document data.
*
* To get more information about Schema, see:
*
* * [API documentation](https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.dataStores.schemas)
* * How-to Guides
* * [Provide a schema for your data store](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)
*
* ## Example Usage
*
* ### Discoveryengine Schema 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-structured-datastore",
* industryVertical: "GENERIC",
* contentConfig: "NO_CONTENT",
* solutionTypes: ["SOLUTION_TYPE_SEARCH"],
* createAdvancedSiteSearch: false,
* skipDefaultSchemaCreation: true,
* });
* const basic = new gcp.discoveryengine.Schema("basic", {
* location: basicDataStore.location,
* dataStoreId: basicDataStore.dataStoreId,
* schemaId: "schema-id",
* jsonSchema: "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"datetime_detection\":true,\"type\":\"object\",\"geolocation_detection\":true}",
* });
* ```
*
* ## Import
*
* Schema can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}/schemas/{{schema_id}}`
*
* * `{{project}}/{{location}}/{{data_store_id}}/{{schema_id}}`
*
* * `{{location}}/{{data_store_id}}/{{schema_id}}`
*
* When using the `pulumi import` command, Schema can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:discoveryengine/schema:Schema default projects/{{project}}/locations/{{location}}/collections/default_collection/dataStores/{{data_store_id}}/schemas/{{schema_id}}
* ```
*
* ```sh
* $ pulumi import gcp:discoveryengine/schema:Schema default {{project}}/{{location}}/{{data_store_id}}/{{schema_id}}
* ```
*
* ```sh
* $ pulumi import gcp:discoveryengine/schema:Schema default {{location}}/{{data_store_id}}/{{schema_id}}
* ```
*/
class Schema extends pulumi.CustomResource {
/**
* Get an existing Schema 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, id, state, opts) {
return new Schema(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Schema. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Schema.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["dataStoreId"] = state?.dataStoreId;
resourceInputs["jsonSchema"] = state?.jsonSchema;
resourceInputs["location"] = state?.location;
resourceInputs["name"] = state?.name;
resourceInputs["project"] = state?.project;
resourceInputs["schemaId"] = state?.schemaId;
}
else {
const args = argsOrState;
if (args?.dataStoreId === undefined && !opts.urn) {
throw new Error("Missing required property 'dataStoreId'");
}
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.schemaId === undefined && !opts.urn) {
throw new Error("Missing required property 'schemaId'");
}
resourceInputs["dataStoreId"] = args?.dataStoreId;
resourceInputs["jsonSchema"] = args?.jsonSchema;
resourceInputs["location"] = args?.location;
resourceInputs["project"] = args?.project;
resourceInputs["schemaId"] = args?.schemaId;
resourceInputs["name"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Schema.__pulumiType, name, resourceInputs, opts);
}
}
exports.Schema = Schema;
/** @internal */
Schema.__pulumiType = 'gcp:discoveryengine/schema:Schema';
//# sourceMappingURL=schema.js.map