@pulumi/gcp/migrationcenter/importJob.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";
/**
 * ImportJob represents a batch data import task that processes uploaded data files and populates Migration Center assets.
 *
 * ## Example Usage
 *
 * ### Migration Center Import Job Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.migrationcenter.Source("default", {
 *     location: "us-central1",
 *     sourceId: "source-test",
 *     type: "SOURCE_TYPE_CUSTOM",
 * });
 * const defaultImportJob = new gcp.migrationcenter.ImportJob("default", {
 *     location: "us-central1",
 *     importJobId: "import-job-test",
 *     assetSource: _default.id,
 *     displayName: "Terraform integration test display",
 *     labels: {
 *         my_key: "value",
 *         second_key: "second_value",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * ImportJob can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/importJobs/{{import_job_id}}`
 * * `{{project}}/{{location}}/{{import_job_id}}`
 * * `{{location}}/{{import_job_id}}`
 *
 * When using the `pulumi import` command, ImportJob can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:migrationcenter/importJob:ImportJob default projects/{{project}}/locations/{{location}}/importJobs/{{import_job_id}}
 * $ pulumi import gcp:migrationcenter/importJob:ImportJob default {{project}}/{{location}}/{{import_job_id}}
 * $ pulumi import gcp:migrationcenter/importJob:ImportJob default {{location}}/{{import_job_id}}
 * ```
 */
export declare class ImportJob extends pulumi.CustomResource {
    /**
     * Get an existing ImportJob 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?: ImportJobState, opts?: pulumi.CustomResourceOptions): ImportJob;
    /**
     * Returns true if the given object is an instance of ImportJob.  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 ImportJob;
    /**
     * Reference to a source.
     */
    readonly assetSource: pulumi.Output<string>;
    /**
     * The timestamp when the import job was completed.
     */
    readonly completeTime: pulumi.Output<string>;
    /**
     * The timestamp when the import job 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>;
    /**
     * User-friendly display name. Maximum length is 256 characters.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * 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;
    }>;
    /**
     * A resource that reports result of the import job execution.
     * Structure is documented below.
     */
    readonly executionReports: pulumi.Output<outputs.migrationcenter.ImportJobExecutionReport[]>;
    /**
     * ID of the import job.
     */
    readonly importJobId: pulumi.Output<string>;
    /**
     * Labels as key value pairs.
     * **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>;
    /**
     * 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>;
    /**
     * The full name of the import job.
     */
    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 combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The state of the import job.
     * Possible values:
     * IMPORT_JOB_STATE_PENDING
     * IMPORT_JOB_STATE_RUNNING
     * IMPORT_JOB_STATE_COMPLETED
     * IMPORT_JOB_STATE_FAILED
     * IMPORT_JOB_STATE_VALIDATING
     * IMPORT_JOB_STATE_FAILED_VALIDATION
     * IMPORT_JOB_STATE_READY
     */
    readonly state: pulumi.Output<string>;
    /**
     * The timestamp when the import job was last updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * A resource that aggregates errors across import job files.
     * Structure is documented below.
     */
    readonly validationReports: pulumi.Output<outputs.migrationcenter.ImportJobValidationReport[]>;
    /**
     * Create a ImportJob 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: ImportJobArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ImportJob resources.
 */
export interface ImportJobState {
    /**
     * Reference to a source.
     */
    assetSource?: pulumi.Input<string | undefined>;
    /**
     * The timestamp when the import job was completed.
     */
    completeTime?: pulumi.Input<string | undefined>;
    /**
     * The timestamp when the import job 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>;
    /**
     * User-friendly display name. Maximum length is 256 characters.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * 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<string>;
    } | undefined>;
    /**
     * A resource that reports result of the import job execution.
     * Structure is documented below.
     */
    executionReports?: pulumi.Input<pulumi.Input<inputs.migrationcenter.ImportJobExecutionReport>[] | undefined>;
    /**
     * ID of the import job.
     */
    importJobId?: pulumi.Input<string | undefined>;
    /**
     * Labels as key value pairs.
     * **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<string>;
    } | 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>;
    /**
     * The full name of the import job.
     */
    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 combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The state of the import job.
     * Possible values:
     * IMPORT_JOB_STATE_PENDING
     * IMPORT_JOB_STATE_RUNNING
     * IMPORT_JOB_STATE_COMPLETED
     * IMPORT_JOB_STATE_FAILED
     * IMPORT_JOB_STATE_VALIDATING
     * IMPORT_JOB_STATE_FAILED_VALIDATION
     * IMPORT_JOB_STATE_READY
     */
    state?: pulumi.Input<string | undefined>;
    /**
     * The timestamp when the import job was last updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
    /**
     * A resource that aggregates errors across import job files.
     * Structure is documented below.
     */
    validationReports?: pulumi.Input<pulumi.Input<inputs.migrationcenter.ImportJobValidationReport>[] | undefined>;
}
/**
 * The set of arguments for constructing a ImportJob resource.
 */
export interface ImportJobArgs {
    /**
     * Reference to a source.
     */
    assetSource: pulumi.Input<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.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * User-friendly display name. Maximum length is 256 characters.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * ID of the import job.
     */
    importJobId: pulumi.Input<string>;
    /**
     * Labels as key value pairs.
     * **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<string>;
    } | 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>;
}
//# sourceMappingURL=importJob.d.ts.map