@pulumi/gcp/contactcenterinsights/assessmentRule.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 assessment rule. This assessment rule will be
 * applied to all conversations from the previous sampling cycle that match the
 * sample rule defined in the assessment rule. One project can have multiple
 * assessment rules.
 *
 * To get more information about AssessmentRule, see:
 *
 * * [API documentation](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations.assessmentRules)
 * * How-to Guides
 *     * [Configure assessment rules using the API](https://cloud.google.com/contact-center/insights/docs/assessment-rule)
 *
 * ## Example Usage
 *
 * ## Import
 *
 * AssessmentRule can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/assessmentRules/{{name}}`
 * * `{{project}}/{{location}}/{{name}}`
 * * `{{location}}/{{name}}`
 *
 * When using the `pulumi import` command, AssessmentRule can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:contactcenterinsights/assessmentRule:AssessmentRule default projects/{{project}}/locations/{{location}}/assessmentRules/{{name}}
 * $ pulumi import gcp:contactcenterinsights/assessmentRule:AssessmentRule default {{project}}/{{location}}/{{name}}
 * $ pulumi import gcp:contactcenterinsights/assessmentRule:AssessmentRule default {{location}}/{{name}}
 * ```
 */
export declare class AssessmentRule extends pulumi.CustomResource {
    /**
     * Get an existing AssessmentRule 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?: AssessmentRuleState, opts?: pulumi.CustomResourceOptions): AssessmentRule;
    /**
     * Returns true if the given object is an instance of AssessmentRule.  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 AssessmentRule;
    /**
     * If true, apply this rule to conversations. Otherwise, this rule is
     * inactive.
     */
    readonly active: pulumi.Output<boolean | undefined>;
    /**
     * A unique ID for the new AssessmentRule. This ID will become the final
     * component of the AssessmentRule'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 assessmentRuleId: pulumi.Output<string | undefined>;
    /**
     * The time at which this assessment 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>;
    /**
     * Display Name of the assessment rule.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * Location of the resource.
     */
    readonly location: pulumi.Output<string>;
    /**
     * Identifier. The resource name of the assessment rule.
     * Format:
     * projects/{project}/locations/{location}/assessmentRules/{assessment_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>;
    /**
     * Message for sampling conversations.
     * Structure is documented below.
     */
    readonly sampleRule: pulumi.Output<outputs.contactcenterinsights.AssessmentRuleSampleRule | undefined>;
    /**
     * Message for schedule info.
     * Structure is documented below.
     */
    readonly scheduleInfo: pulumi.Output<outputs.contactcenterinsights.AssessmentRuleScheduleInfo | undefined>;
    /**
     * The most recent time at which this assessment rule was updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a AssessmentRule 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: AssessmentRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AssessmentRule resources.
 */
export interface AssessmentRuleState {
    /**
     * If true, apply this rule to conversations. Otherwise, this rule is
     * inactive.
     */
    active?: pulumi.Input<boolean | undefined>;
    /**
     * A unique ID for the new AssessmentRule. This ID will become the final
     * component of the AssessmentRule'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}$`.
     */
    assessmentRuleId?: pulumi.Input<string | undefined>;
    /**
     * The time at which this assessment 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>;
    /**
     * Display Name of the assessment rule.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * Location of the resource.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * Identifier. The resource name of the assessment rule.
     * Format:
     * projects/{project}/locations/{location}/assessmentRules/{assessment_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>;
    /**
     * Message for sampling conversations.
     * Structure is documented below.
     */
    sampleRule?: pulumi.Input<inputs.contactcenterinsights.AssessmentRuleSampleRule | undefined>;
    /**
     * Message for schedule info.
     * Structure is documented below.
     */
    scheduleInfo?: pulumi.Input<inputs.contactcenterinsights.AssessmentRuleScheduleInfo | undefined>;
    /**
     * The most recent time at which this assessment rule was updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a AssessmentRule resource.
 */
export interface AssessmentRuleArgs {
    /**
     * If true, apply this rule to conversations. Otherwise, this rule is
     * inactive.
     */
    active?: pulumi.Input<boolean | undefined>;
    /**
     * A unique ID for the new AssessmentRule. This ID will become the final
     * component of the AssessmentRule'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}$`.
     */
    assessmentRuleId?: 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>;
    /**
     * Display Name of the assessment rule.
     */
    displayName?: 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>;
    /**
     * Message for sampling conversations.
     * Structure is documented below.
     */
    sampleRule?: pulumi.Input<inputs.contactcenterinsights.AssessmentRuleSampleRule | undefined>;
    /**
     * Message for schedule info.
     * Structure is documented below.
     */
    scheduleInfo?: pulumi.Input<inputs.contactcenterinsights.AssessmentRuleScheduleInfo | undefined>;
}
//# sourceMappingURL=assessmentRule.d.ts.map