@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
169 lines (168 loc) • 6.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A document schema is used to define document structure.
*
* To get more information about DocumentSchema, see:
*
* * [API documentation](https://cloud.google.com/document-warehouse/docs/reference/rest/v1/projects.locations.documentSchemas)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/document-warehouse/docs/manage-document-schemas)
*
* ## Example Usage
*
* ### Document Ai Warehouse Document Schema Text
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const exampleText = new gcp.essentialcontacts.DocumentAiWarehouseDocumentSchema("example_text", {
* projectNumber: project.then(project => project.number),
* displayName: "test-property-text",
* location: "us",
* documentIsFolder: false,
* propertyDefinitions: [{
* name: "prop3",
* displayName: "propdisp3",
* isRepeatable: false,
* isFilterable: true,
* isSearchable: true,
* isMetadata: false,
* isRequired: false,
* retrievalImportance: "HIGHEST",
* schemaSources: [{
* name: "dummy_source",
* processorType: "dummy_processor",
* }],
* textTypeOptions: {},
* }],
* });
* ```
*
* ## Import
*
* DocumentSchema can be imported using any of these accepted formats:
*
* * `projects/{{project_number}}/locations/{{location}}/documentSchemas/{{name}}`
*
* * `{{project_number}}/{{location}}/{{name}}`
*
* When using the `pulumi import` command, DocumentSchema can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:essentialcontacts/documentAiWarehouseDocumentSchema:DocumentAiWarehouseDocumentSchema default projects/{{project_number}}/locations/{{location}}/documentSchemas/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:essentialcontacts/documentAiWarehouseDocumentSchema:DocumentAiWarehouseDocumentSchema default {{project_number}}/{{location}}/{{name}}
* ```
*/
export declare class DocumentAiWarehouseDocumentSchema extends pulumi.CustomResource {
/**
* Get an existing DocumentAiWarehouseDocumentSchema 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?: DocumentAiWarehouseDocumentSchemaState, opts?: pulumi.CustomResourceOptions): DocumentAiWarehouseDocumentSchema;
/**
* Returns true if the given object is an instance of DocumentAiWarehouseDocumentSchema. 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 DocumentAiWarehouseDocumentSchema;
/**
* Name of the schema given by the user.
*/
readonly displayName: pulumi.Output<string>;
/**
* Tells whether the document is a folder or a typical document.
*/
readonly documentIsFolder: pulumi.Output<boolean | undefined>;
/**
* The location of the resource.
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of the document schema.
*/
readonly name: pulumi.Output<string>;
/**
* The unique identifier of the project.
*/
readonly projectNumber: pulumi.Output<string>;
/**
* Defines the metadata for a schema property.
* Structure is documented below.
*/
readonly propertyDefinitions: pulumi.Output<outputs.essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinition[]>;
/**
* Create a DocumentAiWarehouseDocumentSchema 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: DocumentAiWarehouseDocumentSchemaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DocumentAiWarehouseDocumentSchema resources.
*/
export interface DocumentAiWarehouseDocumentSchemaState {
/**
* Name of the schema given by the user.
*/
displayName?: pulumi.Input<string>;
/**
* Tells whether the document is a folder or a typical document.
*/
documentIsFolder?: pulumi.Input<boolean>;
/**
* The location of the resource.
*/
location?: pulumi.Input<string>;
/**
* The resource name of the document schema.
*/
name?: pulumi.Input<string>;
/**
* The unique identifier of the project.
*/
projectNumber?: pulumi.Input<string>;
/**
* Defines the metadata for a schema property.
* Structure is documented below.
*/
propertyDefinitions?: pulumi.Input<pulumi.Input<inputs.essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinition>[]>;
}
/**
* The set of arguments for constructing a DocumentAiWarehouseDocumentSchema resource.
*/
export interface DocumentAiWarehouseDocumentSchemaArgs {
/**
* Name of the schema given by the user.
*/
displayName: pulumi.Input<string>;
/**
* Tells whether the document is a folder or a typical document.
*/
documentIsFolder?: pulumi.Input<boolean>;
/**
* The location of the resource.
*/
location: pulumi.Input<string>;
/**
* The unique identifier of the project.
*/
projectNumber: pulumi.Input<string>;
/**
* Defines the metadata for a schema property.
* Structure is documented below.
*/
propertyDefinitions: pulumi.Input<pulumi.Input<inputs.essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinition>[]>;
}