import * as pulumi from "@pulumi/pulumi"; /** * Represents a collection of categories and terms defined by the user. Glossary is a top level resource and is the GCP parent resource of all the categories and terms within it. * * ## Example Usage * * ### Dataplex Glossary Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const glossaryTestId = new gcp.dataplex.Glossary("glossary_test_id", { * glossaryId: "glossary-basic", * location: "us-central1", * }); * ``` * ### Dataplex Glossary Full * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const glossaryTestIdFull = new gcp.dataplex.Glossary("glossary_test_id_full", { * glossaryId: "glossary-full", * location: "us-central1", * labels: { * tag: "test-tf", * }, * displayName: "terraform glossary", * description: "glossary created by Terraform", * }); * ``` * * ## Import * * Glossary can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}` * * * `{{project}}/{{location}}/{{glossary_id}}` * * * `{{location}}/{{glossary_id}}` * * When using the `pulumi import` command, Glossary can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:dataplex/glossary:Glossary default projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}} * ``` * * ```sh * $ pulumi import gcp:dataplex/glossary:Glossary default {{project}}/{{location}}/{{glossary_id}} * ``` * * ```sh * $ pulumi import gcp:dataplex/glossary:Glossary default {{location}}/{{glossary_id}} * ``` */ export declare class Glossary extends pulumi.CustomResource { /** * Get an existing Glossary 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?: GlossaryState, opts?: pulumi.CustomResourceOptions): Glossary; /** * Returns true if the given object is an instance of Glossary. 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 Glossary; /** * The number of categories in the glossary. */ readonly categoryCount: pulumi.Output; /** * The time at which the glossary was created. */ readonly createTime: pulumi.Output; /** * The user-mutable description of the glossary. */ readonly description: pulumi.Output; /** * User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, 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 Glossary. * * **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 should reside. */ readonly location: pulumi.Output; /** * The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} */ readonly name: 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; }>; /** * The number of terms in the glossary. */ readonly termCount: pulumi.Output; /** * System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name. */ readonly uid: pulumi.Output; /** * The time at which the glossary was last updated. */ readonly updateTime: pulumi.Output; /** * Create a Glossary 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: GlossaryArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Glossary resources. */ export interface GlossaryState { /** * The number of categories in the glossary. */ categoryCount?: pulumi.Input; /** * The time at which the glossary was created. */ createTime?: pulumi.Input; /** * The user-mutable description of the glossary. */ description?: pulumi.Input; /** * User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, 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; }>; /** * The glossary id for creation. */ glossaryId?: pulumi.Input; /** * User-defined labels for the Glossary. * * **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; }>; /** * The location where the glossary should reside. */ location?: pulumi.Input; /** * The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} */ name?: 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; }>; /** * The number of terms in the glossary. */ termCount?: pulumi.Input; /** * System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name. */ uid?: pulumi.Input; /** * The time at which the glossary was last updated. */ updateTime?: pulumi.Input; } /** * The set of arguments for constructing a Glossary resource. */ export interface GlossaryArgs { /** * The user-mutable description of the glossary. */ description?: pulumi.Input; /** * User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified. */ displayName?: pulumi.Input; /** * The glossary id for creation. */ glossaryId: pulumi.Input; /** * User-defined labels for the Glossary. * * **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; }>; /** * The location where the glossary should reside. */ location: 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; }