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

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

import * as pulumi from "@pulumi/pulumi";
/**
 * A QaScorecard represents a collection of questions to be scored during analysis.
 *
 * ## Example Usage
 *
 * ## Import
 *
 * QaScorecard can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/qaScorecards/{{qa_scorecard_id}}`
 * * `{{project}}/{{location}}/{{qa_scorecard_id}}`
 * * `{{location}}/{{qa_scorecard_id}}`
 *
 * When using the `pulumi import` command, QaScorecard can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:contactcenterinsights/qaScorecard:QaScorecard default projects/{{project}}/locations/{{location}}/qaScorecards/{{qa_scorecard_id}}
 * $ pulumi import gcp:contactcenterinsights/qaScorecard:QaScorecard default {{project}}/{{location}}/{{qa_scorecard_id}}
 * $ pulumi import gcp:contactcenterinsights/qaScorecard:QaScorecard default {{location}}/{{qa_scorecard_id}}
 * ```
 */
export declare class QaScorecard extends pulumi.CustomResource {
    /**
     * Get an existing QaScorecard 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?: QaScorecardState, opts?: pulumi.CustomResourceOptions): QaScorecard;
    /**
     * Returns true if the given object is an instance of QaScorecard.  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 QaScorecard;
    /**
     * The time at which this scorecard 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>;
    /**
     * A text description explaining the intent of the scorecard.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The user-specified display name of the scorecard.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * Whether the scorecard is the default one for the project.
     * A default scorecard cannot be deleted and will always appear first in
     * scorecard selector.
     */
    readonly isDefault: pulumi.Output<boolean | undefined>;
    /**
     * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    readonly location: pulumi.Output<string>;
    /**
     * Identifier. The scorecard name.
     * Format:
     * projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
     */
    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>;
    /**
     * A unique ID for the new QaScorecard. This ID will become the final
     * component of the QaScorecard'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-z0-9-]{4,64}$`. Valid characters are `a-z-`.
     */
    readonly qaScorecardId: pulumi.Output<string>;
    /**
     * Possible values:
     * QA_SCORECARD_SOURCE_CUSTOMER_DEFINED
     * QA_SCORECARD_SOURCE_DISCOVERY_ENGINE
     */
    readonly source: pulumi.Output<string | undefined>;
    /**
     * The most recent time at which the scorecard was updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a QaScorecard 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: QaScorecardArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering QaScorecard resources.
 */
export interface QaScorecardState {
    /**
     * The time at which this scorecard 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>;
    /**
     * A text description explaining the intent of the scorecard.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The user-specified display name of the scorecard.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * Whether the scorecard is the default one for the project.
     * A default scorecard cannot be deleted and will always appear first in
     * scorecard selector.
     */
    isDefault?: pulumi.Input<boolean | undefined>;
    /**
     * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * Identifier. The scorecard name.
     * Format:
     * projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
     */
    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>;
    /**
     * A unique ID for the new QaScorecard. This ID will become the final
     * component of the QaScorecard'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-z0-9-]{4,64}$`. Valid characters are `a-z-`.
     */
    qaScorecardId?: pulumi.Input<string | undefined>;
    /**
     * Possible values:
     * QA_SCORECARD_SOURCE_CUSTOMER_DEFINED
     * QA_SCORECARD_SOURCE_DISCOVERY_ENGINE
     */
    source?: pulumi.Input<string | undefined>;
    /**
     * The most recent time at which the scorecard was updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a QaScorecard resource.
 */
export interface QaScorecardArgs {
    /**
     * 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>;
    /**
     * A text description explaining the intent of the scorecard.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The user-specified display name of the scorecard.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * Whether the scorecard is the default one for the project.
     * A default scorecard cannot be deleted and will always appear first in
     * scorecard selector.
     */
    isDefault?: pulumi.Input<boolean | undefined>;
    /**
     * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    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>;
    /**
     * A unique ID for the new QaScorecard. This ID will become the final
     * component of the QaScorecard'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-z0-9-]{4,64}$`. Valid characters are `a-z-`.
     */
    qaScorecardId: pulumi.Input<string>;
    /**
     * Possible values:
     * QA_SCORECARD_SOURCE_CUSTOMER_DEFINED
     * QA_SCORECARD_SOURCE_DISCOVERY_ENGINE
     */
    source?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=qaScorecard.d.ts.map