@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
152 lines • 7.12 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.GlossaryCategory = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Represents a collection of categories and terms within a Glossary that are related to each other.
*
* ## Example Usage
*
* ### Dataplex Glossary Category Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const categoryTestId = new gcp.dataplex.Glossary("category_test_id", {
* glossaryId: "tf-test-glossary_64336",
* location: "us-central1",
* });
* const categoryTestIdGlossaryCategory = new gcp.dataplex.GlossaryCategory("category_test_id", {
* parent: pulumi.interpolate`projects/${categoryTestId.project}/locations/us-central1/glossaries/${categoryTestId.glossaryId}`,
* glossaryId: categoryTestId.glossaryId,
* location: "us-central1",
* categoryId: "tf-test-category-basic_34962",
* });
* ```
* ### Dataplex Glossary Category Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const categoryTestIdFull = new gcp.dataplex.Glossary("category_test_id_full", {
* glossaryId: "tf-test-glossary_74000",
* location: "us-central1",
* });
* const categoryTestIdFullGlossaryCategory = new gcp.dataplex.GlossaryCategory("category_test_id_full", {
* parent: pulumi.interpolate`projects/${categoryTestIdFull.project}/locations/us-central1/glossaries/${categoryTestIdFull.glossaryId}`,
* glossaryId: categoryTestIdFull.glossaryId,
* location: "us-central1",
* categoryId: "tf-test-category-full_75125",
* labels: {
* tag: "test-tf",
* },
* displayName: "terraform category",
* description: "category created by Terraform",
* });
* ```
*
* ## Import
*
* GlossaryCategory can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/categories/{{category_id}}`
*
* * `{{project}}/{{location}}/{{glossary_id}}/{{category_id}}`
*
* * `{{location}}/{{glossary_id}}/{{category_id}}`
*
* When using the `pulumi import` command, GlossaryCategory can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:dataplex/glossaryCategory:GlossaryCategory default projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/categories/{{category_id}}
* ```
*
* ```sh
* $ pulumi import gcp:dataplex/glossaryCategory:GlossaryCategory default {{project}}/{{location}}/{{glossary_id}}/{{category_id}}
* ```
*
* ```sh
* $ pulumi import gcp:dataplex/glossaryCategory:GlossaryCategory default {{location}}/{{glossary_id}}/{{category_id}}
* ```
*/
class GlossaryCategory extends pulumi.CustomResource {
/**
* Get an existing GlossaryCategory 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 GlossaryCategory(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of GlossaryCategory. 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'] === GlossaryCategory.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["categoryId"] = state ? state.categoryId : undefined;
resourceInputs["createTime"] = state ? state.createTime : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["displayName"] = state ? state.displayName : undefined;
resourceInputs["effectiveLabels"] = state ? state.effectiveLabels : undefined;
resourceInputs["glossaryId"] = state ? state.glossaryId : undefined;
resourceInputs["labels"] = state ? state.labels : undefined;
resourceInputs["location"] = state ? state.location : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["parent"] = state ? state.parent : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["pulumiLabels"] = state ? state.pulumiLabels : undefined;
resourceInputs["uid"] = state ? state.uid : undefined;
resourceInputs["updateTime"] = state ? state.updateTime : undefined;
}
else {
const args = argsOrState;
if ((!args || args.location === undefined) && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if ((!args || args.parent === undefined) && !opts.urn) {
throw new Error("Missing required property 'parent'");
}
resourceInputs["categoryId"] = args ? args.categoryId : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["displayName"] = args ? args.displayName : undefined;
resourceInputs["glossaryId"] = args ? args.glossaryId : undefined;
resourceInputs["labels"] = args ? args.labels : undefined;
resourceInputs["location"] = args ? args.location : undefined;
resourceInputs["parent"] = args ? args.parent : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["uid"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(GlossaryCategory.__pulumiType, name, resourceInputs, opts);
}
}
exports.GlossaryCategory = GlossaryCategory;
/** @internal */
GlossaryCategory.__pulumiType = 'gcp:dataplex/glossaryCategory:GlossaryCategory';
//# sourceMappingURL=glossaryCategory.js.map