import * as pulumi from "@pulumi/pulumi"; /** * 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_4866", * 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_12618", * }); * ``` * ### 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_32270", * 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_44703", * 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}} * $ pulumi import gcp:dataplex/glossaryCategory:GlossaryCategory default {{project}}/{{location}}/{{glossary_id}}/{{category_id}} * $ pulumi import gcp:dataplex/glossaryCategory:GlossaryCategory default {{location}}/{{glossary_id}}/{{category_id}} * ``` */ export declare 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: string, id: pulumi.Input, state?: GlossaryCategoryState, opts?: pulumi.CustomResourceOptions): GlossaryCategory; /** * 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: any): obj is GlossaryCategory; /** * The category id for creation. */ readonly categoryId: pulumi.Output; /** * The time at which the GlossaryCategory was created. */ readonly createTime: pulumi.Output; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ readonly deletionPolicy: pulumi.Output; /** * The user-mutable description of the GlossaryCategory. */ readonly description: pulumi.Output; /** * User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified. */ readonly displayName: pulumi.Output; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * The glossary id for creation. */ readonly glossaryId: pulumi.Output; /** * User-defined labels for the GlossaryCategory. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The location where the glossary category should reside. */ readonly location: pulumi.Output; /** * The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId} */ readonly name: pulumi.Output; /** * The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId} */ readonly parent: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name. */ readonly uid: pulumi.Output; /** * The time at which the GlossaryCategory was last updated. */ readonly updateTime: pulumi.Output; /** * Create a GlossaryCategory 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: GlossaryCategoryArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering GlossaryCategory resources. */ export interface GlossaryCategoryState { /** * The category id for creation. */ categoryId?: pulumi.Input; /** * The time at which the GlossaryCategory was created. */ createTime?: pulumi.Input; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * The user-mutable description of the GlossaryCategory. */ description?: pulumi.Input; /** * User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified. */ displayName?: pulumi.Input; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The glossary id for creation. */ glossaryId?: pulumi.Input; /** * User-defined labels for the GlossaryCategory. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The location where the glossary category should reside. */ location?: pulumi.Input; /** * The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId} */ name?: pulumi.Input; /** * The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId} */ parent?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name. */ uid?: pulumi.Input; /** * The time at which the GlossaryCategory was last updated. */ updateTime?: pulumi.Input; } /** * The set of arguments for constructing a GlossaryCategory resource. */ export interface GlossaryCategoryArgs { /** * The category id for creation. */ categoryId?: pulumi.Input; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input; /** * The user-mutable description of the GlossaryCategory. */ description?: pulumi.Input; /** * User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified. */ displayName?: pulumi.Input; /** * The glossary id for creation. */ glossaryId?: pulumi.Input; /** * User-defined labels for the GlossaryCategory. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The location where the glossary category should reside. */ location: pulumi.Input; /** * The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId} */ parent: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; } //# sourceMappingURL=glossaryCategory.d.ts.map