UNPKG

@pulumi/gcp

Version:

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

116 lines 4.96 kB
"use strict"; // *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** Object.defineProperty(exports, "__esModule", { value: true }); exports.DocumentAiProcessor = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("../utilities"); /** * The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. * * To get more information about Processor, see: * * * [API documentation](https://cloud.google.com/document-ai/docs/reference/rest/v1/projects.locations.processors) * * How-to Guides * * [Official Documentation](https://cloud.google.com/document-ai/docs/overview) * * ## Example Usage * * ### Documentai Processor * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const processor = new gcp.essentialcontacts.DocumentAiProcessor("processor", { * location: "us", * displayName: "test-processor", * type: "OCR_PROCESSOR", * }); * ``` * * ## Import * * Processor can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/processors/{{name}}` * * * `{{project}}/{{location}}/{{name}}` * * * `{{location}}/{{name}}` * * When using the `pulumi import` command, Processor can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default projects/{{project}}/locations/{{location}}/processors/{{name}} * ``` * * ```sh * $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{project}}/{{location}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{location}}/{{name}} * ``` */ class DocumentAiProcessor extends pulumi.CustomResource { /** * Get an existing DocumentAiProcessor 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 DocumentAiProcessor(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of DocumentAiProcessor. 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'] === DocumentAiProcessor.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["displayName"] = state ? state.displayName : undefined; resourceInputs["kmsKeyName"] = state ? state.kmsKeyName : undefined; resourceInputs["location"] = state ? state.location : undefined; resourceInputs["name"] = state ? state.name : undefined; resourceInputs["project"] = state ? state.project : undefined; resourceInputs["type"] = state ? state.type : undefined; } else { const args = argsOrState; if ((!args || args.displayName === undefined) && !opts.urn) { throw new Error("Missing required property 'displayName'"); } if ((!args || args.location === undefined) && !opts.urn) { throw new Error("Missing required property 'location'"); } if ((!args || args.type === undefined) && !opts.urn) { throw new Error("Missing required property 'type'"); } resourceInputs["displayName"] = args ? args.displayName : undefined; resourceInputs["kmsKeyName"] = args ? args.kmsKeyName : undefined; resourceInputs["location"] = args ? args.location : undefined; resourceInputs["project"] = args ? args.project : undefined; resourceInputs["type"] = args ? args.type : undefined; resourceInputs["name"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(DocumentAiProcessor.__pulumiType, name, resourceInputs, opts); } } exports.DocumentAiProcessor = DocumentAiProcessor; /** @internal */ DocumentAiProcessor.__pulumiType = 'gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor'; //# sourceMappingURL=documentAiProcessor.js.map