@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
176 lines (175 loc) • 6.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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}}
* ```
*/
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: SchemaState, opts?: pulumi.CustomResourceOptions): Schema;
/**
* 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: any): obj is Schema;
/**
* The unique id of the data store.
*/
readonly dataStoreId: pulumi.Output<string>;
/**
* The JSON representation of the schema.
*/
readonly jsonSchema: pulumi.Output<string | undefined>;
/**
* 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 schema. Values are of the format
* `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/schemas/{schema_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 schema.
*/
readonly schemaId: pulumi.Output<string>;
/**
* Create a Schema 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: SchemaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Schema resources.
*/
export interface SchemaState {
/**
* The unique id of the data store.
*/
dataStoreId?: pulumi.Input<string>;
/**
* The JSON representation of the schema.
*/
jsonSchema?: 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 schema. Values are of the format
* `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/schemas/{schema_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 schema.
*/
schemaId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Schema resource.
*/
export interface SchemaArgs {
/**
* The unique id of the data store.
*/
dataStoreId: pulumi.Input<string>;
/**
* The JSON representation of the schema.
*/
jsonSchema?: 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>;
/**
* The unique id of the schema.
*/
schemaId: pulumi.Input<string>;
}