@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a job resource within a Dataproc cluster within GCE. For more information see * [the official dataproc documentation](https://cloud.google.com/dataproc/). * * !> **Note:** This resource does not support 'update' and changing any attributes will cause the resource to be recreated. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const mycluster = new gcp.dataproc.Cluster("mycluster", { * name: "dproc-cluster-unique-name", * region: "us-central1", * }); * // Submit an example spark job to a dataproc cluster * const spark = new gcp.dataproc.Job("spark", { * region: mycluster.region, * forceDelete: true, * placement: { * clusterName: mycluster.name, * }, * sparkConfig: { * mainClass: "org.apache.spark.examples.SparkPi", * jarFileUris: ["file:///usr/lib/spark/examples/jars/spark-examples.jar"], * args: ["1000"], * properties: { * "spark.logConf": "true", * }, * loggingConfig: { * driverLogLevels: { * root: "INFO", * }, * }, * }, * }); * // Submit an example pyspark job to a dataproc cluster * const pyspark = new gcp.dataproc.Job("pyspark", { * region: mycluster.region, * forceDelete: true, * placement: { * clusterName: mycluster.name, * }, * pysparkConfig: { * mainPythonFileUri: "gs://dataproc-examples-2f10d78d114f6aaec76462e3c310f31f/src/pyspark/hello-world/hello-world.py", * properties: { * "spark.logConf": "true", * }, * }, * }); * export const sparkStatus = spark.statuses.apply(statuses => statuses[0].state); * export const pysparkStatus = pyspark.statuses.apply(statuses => statuses[0].state); * ``` * * ## Import * * This resource does not support import. */ export declare class Job extends pulumi.CustomResource { /** * Get an existing Job 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?: JobState, opts?: pulumi.CustomResourceOptions): Job; /** * Returns true if the given object is an instance of Job. 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 Job; /** * If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri. */ readonly driverControlsFilesUri: pulumi.Output<string>; /** * A URI pointing to the location of the stdout of the job's driver program. */ readonly driverOutputResourceUri: pulumi.Output<string>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. * * * `scheduling.max_failures_per_hour` - (Required) Maximum number of times per hour a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. * * * `scheduling.max_failures_total` - (Required) Maximum number of times in total a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * By default, you can only delete inactive jobs within * Dataproc. Setting this to true, and calling destroy, will ensure that the * job is first cancelled before issuing the delete. */ readonly forceDelete: pulumi.Output<boolean | undefined>; /** * The config of Hadoop job */ readonly hadoopConfig: pulumi.Output<outputs.dataproc.JobHadoopConfig | undefined>; /** * The config of hive job */ readonly hiveConfig: pulumi.Output<outputs.dataproc.JobHiveConfig | undefined>; /** * The list of labels (key/value pairs) to add to the job. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field 'effective_labels' for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The config of pag job. */ readonly pigConfig: pulumi.Output<outputs.dataproc.JobPigConfig | undefined>; /** * The config of job placement. */ readonly placement: pulumi.Output<outputs.dataproc.JobPlacement>; /** * The config of presto job */ readonly prestoConfig: pulumi.Output<outputs.dataproc.JobPrestoConfig | undefined>; /** * The project in which the `cluster` can be found and jobs * subsequently run against. 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 config of pySpark job. */ readonly pysparkConfig: pulumi.Output<outputs.dataproc.JobPysparkConfig | undefined>; /** * The reference of the job */ readonly reference: pulumi.Output<outputs.dataproc.JobReference>; /** * The Cloud Dataproc region. This essentially determines which clusters are available * for this job to be submitted to. If not specified, defaults to `global`. */ readonly region: pulumi.Output<string | undefined>; /** * Optional. Job scheduling configuration. */ readonly scheduling: pulumi.Output<outputs.dataproc.JobScheduling | undefined>; /** * The config of the Spark job. */ readonly sparkConfig: pulumi.Output<outputs.dataproc.JobSparkConfig | undefined>; /** * The config of SparkSql job */ readonly sparksqlConfig: pulumi.Output<outputs.dataproc.JobSparksqlConfig | undefined>; /** * The status of the job. */ readonly statuses: pulumi.Output<outputs.dataproc.JobStatus[]>; /** * Create a Job 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: JobArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Job resources. */ export interface JobState { /** * If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri. */ driverControlsFilesUri?: pulumi.Input<string>; /** * A URI pointing to the location of the stdout of the job's driver program. */ driverOutputResourceUri?: pulumi.Input<string>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. * * * `scheduling.max_failures_per_hour` - (Required) Maximum number of times per hour a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. * * * `scheduling.max_failures_total` - (Required) Maximum number of times in total a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * By default, you can only delete inactive jobs within * Dataproc. Setting this to true, and calling destroy, will ensure that the * job is first cancelled before issuing the delete. */ forceDelete?: pulumi.Input<boolean>; /** * The config of Hadoop job */ hadoopConfig?: pulumi.Input<inputs.dataproc.JobHadoopConfig>; /** * The config of hive job */ hiveConfig?: pulumi.Input<inputs.dataproc.JobHiveConfig>; /** * The list of labels (key/value pairs) to add to the job. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field 'effective_labels' for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * The config of pag job. */ pigConfig?: pulumi.Input<inputs.dataproc.JobPigConfig>; /** * The config of job placement. */ placement?: pulumi.Input<inputs.dataproc.JobPlacement>; /** * The config of presto job */ prestoConfig?: pulumi.Input<inputs.dataproc.JobPrestoConfig>; /** * The project in which the `cluster` can be found and jobs * subsequently run against. If it is not provided, the provider project is used. */ project?: pulumi.Input<string>; /** * The combination of labels configured directly on the resource and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * The config of pySpark job. */ pysparkConfig?: pulumi.Input<inputs.dataproc.JobPysparkConfig>; /** * The reference of the job */ reference?: pulumi.Input<inputs.dataproc.JobReference>; /** * The Cloud Dataproc region. This essentially determines which clusters are available * for this job to be submitted to. If not specified, defaults to `global`. */ region?: pulumi.Input<string>; /** * Optional. Job scheduling configuration. */ scheduling?: pulumi.Input<inputs.dataproc.JobScheduling>; /** * The config of the Spark job. */ sparkConfig?: pulumi.Input<inputs.dataproc.JobSparkConfig>; /** * The config of SparkSql job */ sparksqlConfig?: pulumi.Input<inputs.dataproc.JobSparksqlConfig>; /** * The status of the job. */ statuses?: pulumi.Input<pulumi.Input<inputs.dataproc.JobStatus>[]>; } /** * The set of arguments for constructing a Job resource. */ export interface JobArgs { /** * By default, you can only delete inactive jobs within * Dataproc. Setting this to true, and calling destroy, will ensure that the * job is first cancelled before issuing the delete. */ forceDelete?: pulumi.Input<boolean>; /** * The config of Hadoop job */ hadoopConfig?: pulumi.Input<inputs.dataproc.JobHadoopConfig>; /** * The config of hive job */ hiveConfig?: pulumi.Input<inputs.dataproc.JobHiveConfig>; /** * The list of labels (key/value pairs) to add to the job. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field 'effective_labels' for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * The config of pag job. */ pigConfig?: pulumi.Input<inputs.dataproc.JobPigConfig>; /** * The config of job placement. */ placement: pulumi.Input<inputs.dataproc.JobPlacement>; /** * The config of presto job */ prestoConfig?: pulumi.Input<inputs.dataproc.JobPrestoConfig>; /** * The project in which the `cluster` can be found and jobs * subsequently run against. If it is not provided, the provider project is used. */ project?: pulumi.Input<string>; /** * The config of pySpark job. */ pysparkConfig?: pulumi.Input<inputs.dataproc.JobPysparkConfig>; /** * The reference of the job */ reference?: pulumi.Input<inputs.dataproc.JobReference>; /** * The Cloud Dataproc region. This essentially determines which clusters are available * for this job to be submitted to. If not specified, defaults to `global`. */ region?: pulumi.Input<string>; /** * Optional. Job scheduling configuration. */ scheduling?: pulumi.Input<inputs.dataproc.JobScheduling>; /** * The config of the Spark job. */ sparkConfig?: pulumi.Input<inputs.dataproc.JobSparkConfig>; /** * The config of SparkSql job */ sparksqlConfig?: pulumi.Input<inputs.dataproc.JobSparksqlConfig>; }