@pulumi/gcp/contactcenterinsights/autoLabelingRule.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * The CCAI Insights project wide auto labeling rule. This rule will be applied
 * to all conversations that match the filter defined in the rule.
 *
 * To get more information about AutoLabelingRule, see:
 *
 * * [API documentation](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations.autoLabelingRules)
 * * How-to Guides
 *     * [Configure auto labeling rules using the API](https://cloud.google.com/contact-center/insights/docs/auto-labeling-rule)
 *
 * ## Example Usage
 *
 * ## Import
 *
 * AutoLabelingRule can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/autoLabelingRules/{{name}}`
 * * `{{project}}/{{location}}/{{name}}`
 * * `{{location}}/{{name}}`
 *
 * When using the `pulumi import` command, AutoLabelingRule can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:contactcenterinsights/autoLabelingRule:AutoLabelingRule default projects/{{project}}/locations/{{location}}/autoLabelingRules/{{name}}
 * $ pulumi import gcp:contactcenterinsights/autoLabelingRule:AutoLabelingRule default {{project}}/{{location}}/{{name}}
 * $ pulumi import gcp:contactcenterinsights/autoLabelingRule:AutoLabelingRule default {{location}}/{{name}}
 * ```
 */
export declare class AutoLabelingRule extends pulumi.CustomResource {
    /**
     * Get an existing AutoLabelingRule 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?: AutoLabelingRuleState, opts?: pulumi.CustomResourceOptions): AutoLabelingRule;
    /**
     * Returns true if the given object is an instance of AutoLabelingRule.  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 AutoLabelingRule;
    /**
     * Whether the rule is active.
     */
    readonly active: pulumi.Output<boolean | undefined>;
    /**
     * A unique ID for the new AutoLabelingRule. This ID will become the final
     * component of the AutoLabelingRule's resource name. If no ID is specified,
     * a server-generated ID will be used.
     * This value should be 4-64 characters and must match the regular
     * expression `^[A-Za-z0-9]{4,64}$`.
     */
    readonly autoLabelingRuleId: pulumi.Output<string | undefined>;
    /**
     * Conditions to apply for auto-labeling the label_key.
     * Structure is documented below.
     */
    readonly conditions: pulumi.Output<outputs.contactcenterinsights.AutoLabelingRuleCondition[] | undefined>;
    /**
     * The time at which this rule was created.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * 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<string>;
    /**
     * The description of the rule.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Display Name of the auto labeling rule.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * The label key.
     */
    readonly labelKey: pulumi.Output<string | undefined>;
    /**
     * The type of the label key.
     * Possible values are: `LABEL_KEY_TYPE_UNSPECIFIED`, `LABEL_KEY_TYPE_CUSTOM`.
     */
    readonly labelKeyType: pulumi.Output<string | undefined>;
    /**
     * Location of the resource.
     */
    readonly location: pulumi.Output<string>;
    /**
     * Identifier. The resource name of the auto labeling rule.
     * Format:
     * projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The most recent time at which this rule was updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a AutoLabelingRule 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: AutoLabelingRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AutoLabelingRule resources.
 */
export interface AutoLabelingRuleState {
    /**
     * Whether the rule is active.
     */
    active?: pulumi.Input<boolean | undefined>;
    /**
     * A unique ID for the new AutoLabelingRule. This ID will become the final
     * component of the AutoLabelingRule's resource name. If no ID is specified,
     * a server-generated ID will be used.
     * This value should be 4-64 characters and must match the regular
     * expression `^[A-Za-z0-9]{4,64}$`.
     */
    autoLabelingRuleId?: pulumi.Input<string | undefined>;
    /**
     * Conditions to apply for auto-labeling the label_key.
     * Structure is documented below.
     */
    conditions?: pulumi.Input<pulumi.Input<inputs.contactcenterinsights.AutoLabelingRuleCondition>[] | undefined>;
    /**
     * The time at which this rule was created.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * 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<string | undefined>;
    /**
     * The description of the rule.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Display Name of the auto labeling rule.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * The label key.
     */
    labelKey?: pulumi.Input<string | undefined>;
    /**
     * The type of the label key.
     * Possible values are: `LABEL_KEY_TYPE_UNSPECIFIED`, `LABEL_KEY_TYPE_CUSTOM`.
     */
    labelKeyType?: pulumi.Input<string | undefined>;
    /**
     * Location of the resource.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * Identifier. The resource name of the auto labeling rule.
     * Format:
     * projects/{project}/locations/{location}/autoLabelingRules/{auto_labeling_rule}
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The most recent time at which this rule was updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a AutoLabelingRule resource.
 */
export interface AutoLabelingRuleArgs {
    /**
     * Whether the rule is active.
     */
    active?: pulumi.Input<boolean | undefined>;
    /**
     * A unique ID for the new AutoLabelingRule. This ID will become the final
     * component of the AutoLabelingRule's resource name. If no ID is specified,
     * a server-generated ID will be used.
     * This value should be 4-64 characters and must match the regular
     * expression `^[A-Za-z0-9]{4,64}$`.
     */
    autoLabelingRuleId?: pulumi.Input<string | undefined>;
    /**
     * Conditions to apply for auto-labeling the label_key.
     * Structure is documented below.
     */
    conditions?: pulumi.Input<pulumi.Input<inputs.contactcenterinsights.AutoLabelingRuleCondition>[] | undefined>;
    /**
     * 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<string | undefined>;
    /**
     * The description of the rule.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Display Name of the auto labeling rule.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * The label key.
     */
    labelKey?: pulumi.Input<string | undefined>;
    /**
     * The type of the label key.
     * Possible values are: `LABEL_KEY_TYPE_UNSPECIFIED`, `LABEL_KEY_TYPE_CUSTOM`.
     */
    labelKeyType?: pulumi.Input<string | undefined>;
    /**
     * Location of the resource.
     */
    location: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=autoLabelingRule.d.ts.map