com.pulumi.gcp.dataplex.kotlin.Task.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.dataplex.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskExecutionSpec
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskExecutionStatus
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskNotebook
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskSpark
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskTriggerSpec
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskExecutionSpec.Companion.toKotlin as taskExecutionSpecToKotlin
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskExecutionStatus.Companion.toKotlin as taskExecutionStatusToKotlin
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskNotebook.Companion.toKotlin as taskNotebookToKotlin
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskSpark.Companion.toKotlin as taskSparkToKotlin
import com.pulumi.gcp.dataplex.kotlin.outputs.TaskTriggerSpec.Companion.toKotlin as taskTriggerSpecToKotlin
/**
* Builder for [Task].
*/
@PulumiTagMarker
public class TaskResourceBuilder internal constructor() {
public var name: String? = null
public var args: TaskArgs = TaskArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend TaskArgsBuilder.() -> Unit) {
val builder = TaskArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Task {
val builtJavaResource = com.pulumi.gcp.dataplex.Task(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Task(builtJavaResource)
}
}
/**
* A Dataplex task represents the work that you want Dataplex to do on a schedule. It encapsulates code, parameters, and the schedule.
* To get more information about Task, see:
* * [API documentation](https://cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.tasks)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/dataplex/docs)
* ## Example Usage
* ### Dataplex Task Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const project = gcp.organizations.getProject({});
* const example = new gcp.dataplex.Lake("example", {
* name: "tf-test-lake_22811",
* location: "us-central1",
* project: "my-project-name",
* });
* const exampleTask = new gcp.dataplex.Task("example", {
* taskId: "tf-test-task_91042",
* location: "us-central1",
* lake: example.name,
* description: "Test Task Basic",
* displayName: "task-basic",
* labels: {
* count: "3",
* },
* triggerSpec: {
* type: "RECURRING",
* disabled: false,
* maxRetries: 3,
* startTime: "2023-10-02T15:01:23Z",
* schedule: "1 * * * *",
* },
* executionSpec: {
* serviceAccount: project.then(project => `${project.number}[email protected]`),
* project: "my-project-name",
* maxJobExecutionLifetime: "100s",
* kmsKey: "234jn2kjn42k3n423",
* },
* spark: {
* pythonScriptFile: "gs://dataproc-examples/pyspark/hello-world/hello-world.py",
* },
* project: "my-project-name",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* project = gcp.organizations.get_project()
* example = gcp.dataplex.Lake("example",
* name="tf-test-lake_22811",
* location="us-central1",
* project="my-project-name")
* example_task = gcp.dataplex.Task("example",
* task_id="tf-test-task_91042",
* location="us-central1",
* lake=example.name,
* description="Test Task Basic",
* display_name="task-basic",
* labels={
* "count": "3",
* },
* trigger_spec=gcp.dataplex.TaskTriggerSpecArgs(
* type="RECURRING",
* disabled=False,
* max_retries=3,
* start_time="2023-10-02T15:01:23Z",
* schedule="1 * * * *",
* ),
* execution_spec=gcp.dataplex.TaskExecutionSpecArgs(
* service_account=f"{project.number}[email protected]",
* project="my-project-name",
* max_job_execution_lifetime="100s",
* kms_key="234jn2kjn42k3n423",
* ),
* spark=gcp.dataplex.TaskSparkArgs(
* python_script_file="gs://dataproc-examples/pyspark/hello-world/hello-world.py",
* ),
* project="my-project-name")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var project = Gcp.Organizations.GetProject.Invoke();
* var example = new Gcp.DataPlex.Lake("example", new()
* {
* Name = "tf-test-lake_22811",
* Location = "us-central1",
* Project = "my-project-name",
* });
* var exampleTask = new Gcp.DataPlex.Task("example", new()
* {
* TaskId = "tf-test-task_91042",
* Location = "us-central1",
* Lake = example.Name,
* Description = "Test Task Basic",
* DisplayName = "task-basic",
* Labels =
* {
* { "count", "3" },
* },
* TriggerSpec = new Gcp.DataPlex.Inputs.TaskTriggerSpecArgs
* {
* Type = "RECURRING",
* Disabled = false,
* MaxRetries = 3,
* StartTime = "2023-10-02T15:01:23Z",
* Schedule = "1 * * * *",
* },
* ExecutionSpec = new Gcp.DataPlex.Inputs.TaskExecutionSpecArgs
* {
* ServiceAccount = $"{project.Apply(getProjectResult => getProjectResult.Number)}[email protected]",
* Project = "my-project-name",
* MaxJobExecutionLifetime = "100s",
* KmsKey = "234jn2kjn42k3n423",
* },
* Spark = new Gcp.DataPlex.Inputs.TaskSparkArgs
* {
* PythonScriptFile = "gs://dataproc-examples/pyspark/hello-world/hello-world.py",
* },
* Project = "my-project-name",
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataplex"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* project, err := organizations.LookupProject(ctx, nil, nil)
* if err != nil {
* return err
* }
* example, err := dataplex.NewLake(ctx, "example", &dataplex.LakeArgs{
* Name: pulumi.String("tf-test-lake_22811"),
* Location: pulumi.String("us-central1"),
* Project: pulumi.String("my-project-name"),
* })
* if err != nil {
* return err
* }
* _, err = dataplex.NewTask(ctx, "example", &dataplex.TaskArgs{
* TaskId: pulumi.String("tf-test-task_91042"),
* Location: pulumi.String("us-central1"),
* Lake: example.Name,
* Description: pulumi.String("Test Task Basic"),
* DisplayName: pulumi.String("task-basic"),
* Labels: pulumi.StringMap{
* "count": pulumi.String("3"),
* },
* TriggerSpec: &dataplex.TaskTriggerSpecArgs{
* Type: pulumi.String("RECURRING"),
* Disabled: pulumi.Bool(false),
* MaxRetries: pulumi.Int(3),
* StartTime: pulumi.String("2023-10-02T15:01:23Z"),
* Schedule: pulumi.String("1 * * * *"),
* },
* ExecutionSpec: &dataplex.TaskExecutionSpecArgs{
* ServiceAccount: pulumi.String(fmt.Sprintf("%[email protected]", project.Number)),
* Project: pulumi.String("my-project-name"),
* MaxJobExecutionLifetime: pulumi.String("100s"),
* KmsKey: pulumi.String("234jn2kjn42k3n423"),
* },
* Spark: &dataplex.TaskSparkArgs{
* PythonScriptFile: pulumi.String("gs://dataproc-examples/pyspark/hello-world/hello-world.py"),
* },
* Project: pulumi.String("my-project-name"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.organizations.OrganizationsFunctions;
* import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
* import com.pulumi.gcp.dataplex.Lake;
* import com.pulumi.gcp.dataplex.LakeArgs;
* import com.pulumi.gcp.dataplex.Task;
* import com.pulumi.gcp.dataplex.TaskArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskTriggerSpecArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskExecutionSpecArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskSparkArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* final var project = OrganizationsFunctions.getProject();
* var example = new Lake("example", LakeArgs.builder()
* .name("tf-test-lake_22811")
* .location("us-central1")
* .project("my-project-name")
* .build());
* var exampleTask = new Task("exampleTask", TaskArgs.builder()
* .taskId("tf-test-task_91042")
* .location("us-central1")
* .lake(example.name())
* .description("Test Task Basic")
* .displayName("task-basic")
* .labels(Map.of("count", "3"))
* .triggerSpec(TaskTriggerSpecArgs.builder()
* .type("RECURRING")
* .disabled(false)
* .maxRetries(3)
* .startTime("2023-10-02T15:01:23Z")
* .schedule("1 * * * *")
* .build())
* .executionSpec(TaskExecutionSpecArgs.builder()
* .serviceAccount(String.format("%[email protected]", project.applyValue(getProjectResult -> getProjectResult.number())))
* .project("my-project-name")
* .maxJobExecutionLifetime("100s")
* .kmsKey("234jn2kjn42k3n423")
* .build())
* .spark(TaskSparkArgs.builder()
* .pythonScriptFile("gs://dataproc-examples/pyspark/hello-world/hello-world.py")
* .build())
* .project("my-project-name")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: gcp:dataplex:Lake
* properties:
* name: tf-test-lake_22811
* location: us-central1
* project: my-project-name
* exampleTask:
* type: gcp:dataplex:Task
* name: example
* properties:
* taskId: tf-test-task_91042
* location: us-central1
* lake: ${example.name}
* description: Test Task Basic
* displayName: task-basic
* labels:
* count: '3'
* triggerSpec:
* type: RECURRING
* disabled: false
* maxRetries: 3
* startTime: 2023-10-02T15:01:23Z
* schedule: 1 * * * *
* executionSpec:
* serviceAccount: ${project.number}[email protected]
* project: my-project-name
* maxJobExecutionLifetime: 100s
* kmsKey: 234jn2kjn42k3n423
* spark:
* pythonScriptFile: gs://dataproc-examples/pyspark/hello-world/hello-world.py
* project: my-project-name
* variables:
* project:
* fn::invoke:
* Function: gcp:organizations:getProject
* Arguments: {}
* ```
*
* ### Dataplex Task Spark
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* // VPC network
* const _default = new gcp.compute.Network("default", {
* name: "tf-test-workstation-cluster_72490",
* autoCreateSubnetworks: true,
* });
* const project = gcp.organizations.getProject({});
* const exampleSpark = new gcp.dataplex.Lake("example_spark", {
* name: "tf-test-lake_89605",
* location: "us-central1",
* project: "my-project-name",
* });
* const exampleSparkTask = new gcp.dataplex.Task("example_spark", {
* taskId: "tf-test-task_56730",
* location: "us-central1",
* lake: exampleSpark.name,
* triggerSpec: {
* type: "ON_DEMAND",
* },
* description: "task-spark-terraform",
* executionSpec: {
* serviceAccount: project.then(project => `${project.number}[email protected]`),
* args: {
* TASK_ARGS: "--output_location,gs://spark-job/task-result, --output_format, json",
* },
* },
* spark: {
* infrastructureSpec: {
* batch: {
* executorsCount: 2,
* maxExecutorsCount: 100,
* },
* containerImage: {
* image: "test-image",
* javaJars: ["test-java-jars.jar"],
* pythonPackages: ["gs://bucket-name/my/path/to/lib.tar.gz"],
* properties: {
* name: "wrench",
* mass: "1.3kg",
* count: "3",
* },
* },
* vpcNetwork: {
* networkTags: ["test-network-tag"],
* subNetwork: _default.id,
* },
* },
* fileUris: ["gs://terrafrom-test/test.csv"],
* archiveUris: ["gs://terraform-test/test.csv"],
* sqlScript: "show databases",
* },
* project: "my-project-name",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* # VPC network
* default = gcp.compute.Network("default",
* name="tf-test-workstation-cluster_72490",
* auto_create_subnetworks=True)
* project = gcp.organizations.get_project()
* example_spark = gcp.dataplex.Lake("example_spark",
* name="tf-test-lake_89605",
* location="us-central1",
* project="my-project-name")
* example_spark_task = gcp.dataplex.Task("example_spark",
* task_id="tf-test-task_56730",
* location="us-central1",
* lake=example_spark.name,
* trigger_spec=gcp.dataplex.TaskTriggerSpecArgs(
* type="ON_DEMAND",
* ),
* description="task-spark-terraform",
* execution_spec=gcp.dataplex.TaskExecutionSpecArgs(
* service_account=f"{project.number}[email protected]",
* args={
* "TASK_ARGS": "--output_location,gs://spark-job/task-result, --output_format, json",
* },
* ),
* spark=gcp.dataplex.TaskSparkArgs(
* infrastructure_spec=gcp.dataplex.TaskSparkInfrastructureSpecArgs(
* batch=gcp.dataplex.TaskSparkInfrastructureSpecBatchArgs(
* executors_count=2,
* max_executors_count=100,
* ),
* container_image=gcp.dataplex.TaskSparkInfrastructureSpecContainerImageArgs(
* image="test-image",
* java_jars=["test-java-jars.jar"],
* python_packages=["gs://bucket-name/my/path/to/lib.tar.gz"],
* properties={
* "name": "wrench",
* "mass": "1.3kg",
* "count": "3",
* },
* ),
* vpc_network=gcp.dataplex.TaskSparkInfrastructureSpecVpcNetworkArgs(
* network_tags=["test-network-tag"],
* sub_network=default.id,
* ),
* ),
* file_uris=["gs://terrafrom-test/test.csv"],
* archive_uris=["gs://terraform-test/test.csv"],
* sql_script="show databases",
* ),
* project="my-project-name")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* // VPC network
* var @default = new Gcp.Compute.Network("default", new()
* {
* Name = "tf-test-workstation-cluster_72490",
* AutoCreateSubnetworks = true,
* });
* var project = Gcp.Organizations.GetProject.Invoke();
* var exampleSpark = new Gcp.DataPlex.Lake("example_spark", new()
* {
* Name = "tf-test-lake_89605",
* Location = "us-central1",
* Project = "my-project-name",
* });
* var exampleSparkTask = new Gcp.DataPlex.Task("example_spark", new()
* {
* TaskId = "tf-test-task_56730",
* Location = "us-central1",
* Lake = exampleSpark.Name,
* TriggerSpec = new Gcp.DataPlex.Inputs.TaskTriggerSpecArgs
* {
* Type = "ON_DEMAND",
* },
* Description = "task-spark-terraform",
* ExecutionSpec = new Gcp.DataPlex.Inputs.TaskExecutionSpecArgs
* {
* ServiceAccount = $"{project.Apply(getProjectResult => getProjectResult.Number)}[email protected]",
* Args =
* {
* { "TASK_ARGS", "--output_location,gs://spark-job/task-result, --output_format, json" },
* },
* },
* Spark = new Gcp.DataPlex.Inputs.TaskSparkArgs
* {
* InfrastructureSpec = new Gcp.DataPlex.Inputs.TaskSparkInfrastructureSpecArgs
* {
* Batch = new Gcp.DataPlex.Inputs.TaskSparkInfrastructureSpecBatchArgs
* {
* ExecutorsCount = 2,
* MaxExecutorsCount = 100,
* },
* ContainerImage = new Gcp.DataPlex.Inputs.TaskSparkInfrastructureSpecContainerImageArgs
* {
* Image = "test-image",
* JavaJars = new[]
* {
* "test-java-jars.jar",
* },
* PythonPackages = new[]
* {
* "gs://bucket-name/my/path/to/lib.tar.gz",
* },
* Properties =
* {
* { "name", "wrench" },
* { "mass", "1.3kg" },
* { "count", "3" },
* },
* },
* VpcNetwork = new Gcp.DataPlex.Inputs.TaskSparkInfrastructureSpecVpcNetworkArgs
* {
* NetworkTags = new[]
* {
* "test-network-tag",
* },
* SubNetwork = @default.Id,
* },
* },
* FileUris = new[]
* {
* "gs://terrafrom-test/test.csv",
* },
* ArchiveUris = new[]
* {
* "gs://terraform-test/test.csv",
* },
* SqlScript = "show databases",
* },
* Project = "my-project-name",
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataplex"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* // VPC network
* _, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
* Name: pulumi.String("tf-test-workstation-cluster_72490"),
* AutoCreateSubnetworks: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* project, err := organizations.LookupProject(ctx, nil, nil)
* if err != nil {
* return err
* }
* exampleSpark, err := dataplex.NewLake(ctx, "example_spark", &dataplex.LakeArgs{
* Name: pulumi.String("tf-test-lake_89605"),
* Location: pulumi.String("us-central1"),
* Project: pulumi.String("my-project-name"),
* })
* if err != nil {
* return err
* }
* _, err = dataplex.NewTask(ctx, "example_spark", &dataplex.TaskArgs{
* TaskId: pulumi.String("tf-test-task_56730"),
* Location: pulumi.String("us-central1"),
* Lake: exampleSpark.Name,
* TriggerSpec: &dataplex.TaskTriggerSpecArgs{
* Type: pulumi.String("ON_DEMAND"),
* },
* Description: pulumi.String("task-spark-terraform"),
* ExecutionSpec: &dataplex.TaskExecutionSpecArgs{
* ServiceAccount: pulumi.String(fmt.Sprintf("%[email protected]", project.Number)),
* Args: pulumi.StringMap{
* "TASK_ARGS": pulumi.String("--output_location,gs://spark-job/task-result, --output_format, json"),
* },
* },
* Spark: &dataplex.TaskSparkArgs{
* InfrastructureSpec: &dataplex.TaskSparkInfrastructureSpecArgs{
* Batch: &dataplex.TaskSparkInfrastructureSpecBatchArgs{
* ExecutorsCount: pulumi.Int(2),
* MaxExecutorsCount: pulumi.Int(100),
* },
* ContainerImage: &dataplex.TaskSparkInfrastructureSpecContainerImageArgs{
* Image: pulumi.String("test-image"),
* JavaJars: pulumi.StringArray{
* pulumi.String("test-java-jars.jar"),
* },
* PythonPackages: pulumi.StringArray{
* pulumi.String("gs://bucket-name/my/path/to/lib.tar.gz"),
* },
* Properties: pulumi.StringMap{
* "name": pulumi.String("wrench"),
* "mass": pulumi.String("1.3kg"),
* "count": pulumi.String("3"),
* },
* },
* VpcNetwork: &dataplex.TaskSparkInfrastructureSpecVpcNetworkArgs{
* NetworkTags: pulumi.StringArray{
* pulumi.String("test-network-tag"),
* },
* SubNetwork: _default.ID(),
* },
* },
* FileUris: pulumi.StringArray{
* pulumi.String("gs://terrafrom-test/test.csv"),
* },
* ArchiveUris: pulumi.StringArray{
* pulumi.String("gs://terraform-test/test.csv"),
* },
* SqlScript: pulumi.String("show databases"),
* },
* Project: pulumi.String("my-project-name"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.compute.Network;
* import com.pulumi.gcp.compute.NetworkArgs;
* import com.pulumi.gcp.organizations.OrganizationsFunctions;
* import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
* import com.pulumi.gcp.dataplex.Lake;
* import com.pulumi.gcp.dataplex.LakeArgs;
* import com.pulumi.gcp.dataplex.Task;
* import com.pulumi.gcp.dataplex.TaskArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskTriggerSpecArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskExecutionSpecArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskSparkArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskSparkInfrastructureSpecArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskSparkInfrastructureSpecBatchArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskSparkInfrastructureSpecContainerImageArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskSparkInfrastructureSpecVpcNetworkArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* // VPC network
* var default_ = new Network("default", NetworkArgs.builder()
* .name("tf-test-workstation-cluster_72490")
* .autoCreateSubnetworks(true)
* .build());
* final var project = OrganizationsFunctions.getProject();
* var exampleSpark = new Lake("exampleSpark", LakeArgs.builder()
* .name("tf-test-lake_89605")
* .location("us-central1")
* .project("my-project-name")
* .build());
* var exampleSparkTask = new Task("exampleSparkTask", TaskArgs.builder()
* .taskId("tf-test-task_56730")
* .location("us-central1")
* .lake(exampleSpark.name())
* .triggerSpec(TaskTriggerSpecArgs.builder()
* .type("ON_DEMAND")
* .build())
* .description("task-spark-terraform")
* .executionSpec(TaskExecutionSpecArgs.builder()
* .serviceAccount(String.format("%[email protected]", project.applyValue(getProjectResult -> getProjectResult.number())))
* .args(Map.of("TASK_ARGS", "--output_location,gs://spark-job/task-result, --output_format, json"))
* .build())
* .spark(TaskSparkArgs.builder()
* .infrastructureSpec(TaskSparkInfrastructureSpecArgs.builder()
* .batch(TaskSparkInfrastructureSpecBatchArgs.builder()
* .executorsCount(2)
* .maxExecutorsCount(100)
* .build())
* .containerImage(TaskSparkInfrastructureSpecContainerImageArgs.builder()
* .image("test-image")
* .javaJars("test-java-jars.jar")
* .pythonPackages("gs://bucket-name/my/path/to/lib.tar.gz")
* .properties(Map.ofEntries(
* Map.entry("name", "wrench"),
* Map.entry("mass", "1.3kg"),
* Map.entry("count", "3")
* ))
* .build())
* .vpcNetwork(TaskSparkInfrastructureSpecVpcNetworkArgs.builder()
* .networkTags("test-network-tag")
* .subNetwork(default_.id())
* .build())
* .build())
* .fileUris("gs://terrafrom-test/test.csv")
* .archiveUris("gs://terraform-test/test.csv")
* .sqlScript("show databases")
* .build())
* .project("my-project-name")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* # VPC network
* default:
* type: gcp:compute:Network
* properties:
* name: tf-test-workstation-cluster_72490
* autoCreateSubnetworks: true
* exampleSpark:
* type: gcp:dataplex:Lake
* name: example_spark
* properties:
* name: tf-test-lake_89605
* location: us-central1
* project: my-project-name
* exampleSparkTask:
* type: gcp:dataplex:Task
* name: example_spark
* properties:
* taskId: tf-test-task_56730
* location: us-central1
* lake: ${exampleSpark.name}
* triggerSpec:
* type: ON_DEMAND
* description: task-spark-terraform
* executionSpec:
* serviceAccount: ${project.number}[email protected]
* args:
* TASK_ARGS: --output_location,gs://spark-job/task-result, --output_format, json
* spark:
* infrastructureSpec:
* batch:
* executorsCount: 2
* maxExecutorsCount: 100
* containerImage:
* image: test-image
* javaJars:
* - test-java-jars.jar
* pythonPackages:
* - gs://bucket-name/my/path/to/lib.tar.gz
* properties:
* name: wrench
* mass: 1.3kg
* count: '3'
* vpcNetwork:
* networkTags:
* - test-network-tag
* subNetwork: ${default.id}
* fileUris:
* - gs://terrafrom-test/test.csv
* archiveUris:
* - gs://terraform-test/test.csv
* sqlScript: show databases
* project: my-project-name
* variables:
* project:
* fn::invoke:
* Function: gcp:organizations:getProject
* Arguments: {}
* ```
*
* ### Dataplex Task Notebook
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* // VPC network
* const _default = new gcp.compute.Network("default", {
* name: "tf-test-workstation-cluster_95154",
* autoCreateSubnetworks: true,
* });
* const project = gcp.organizations.getProject({});
* const exampleNotebook = new gcp.dataplex.Lake("example_notebook", {
* name: "tf-test-lake_64336",
* location: "us-central1",
* project: "my-project-name",
* });
* const exampleNotebookTask = new gcp.dataplex.Task("example_notebook", {
* taskId: "tf-test-task_34962",
* location: "us-central1",
* lake: exampleNotebook.name,
* triggerSpec: {
* type: "RECURRING",
* schedule: "1 * * * *",
* },
* executionSpec: {
* serviceAccount: project.then(project => `${project.number}[email protected]`),
* args: {
* TASK_ARGS: "--output_location,gs://spark-job-jars-anrajitha/task-result, --output_format, json",
* },
* },
* notebook: {
* notebook: "gs://terraform-test/test-notebook.ipynb",
* infrastructureSpec: {
* batch: {
* executorsCount: 2,
* maxExecutorsCount: 100,
* },
* containerImage: {
* image: "test-image",
* javaJars: ["test-java-jars.jar"],
* pythonPackages: ["gs://bucket-name/my/path/to/lib.tar.gz"],
* properties: {
* name: "wrench",
* mass: "1.3kg",
* count: "3",
* },
* },
* vpcNetwork: {
* networkTags: ["test-network-tag"],
* network: _default.id,
* },
* },
* fileUris: ["gs://terraform-test/test.csv"],
* archiveUris: ["gs://terraform-test/test.csv"],
* },
* project: "my-project-name",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* # VPC network
* default = gcp.compute.Network("default",
* name="tf-test-workstation-cluster_95154",
* auto_create_subnetworks=True)
* project = gcp.organizations.get_project()
* example_notebook = gcp.dataplex.Lake("example_notebook",
* name="tf-test-lake_64336",
* location="us-central1",
* project="my-project-name")
* example_notebook_task = gcp.dataplex.Task("example_notebook",
* task_id="tf-test-task_34962",
* location="us-central1",
* lake=example_notebook.name,
* trigger_spec=gcp.dataplex.TaskTriggerSpecArgs(
* type="RECURRING",
* schedule="1 * * * *",
* ),
* execution_spec=gcp.dataplex.TaskExecutionSpecArgs(
* service_account=f"{project.number}[email protected]",
* args={
* "TASK_ARGS": "--output_location,gs://spark-job-jars-anrajitha/task-result, --output_format, json",
* },
* ),
* notebook=gcp.dataplex.TaskNotebookArgs(
* notebook="gs://terraform-test/test-notebook.ipynb",
* infrastructure_spec=gcp.dataplex.TaskNotebookInfrastructureSpecArgs(
* batch=gcp.dataplex.TaskNotebookInfrastructureSpecBatchArgs(
* executors_count=2,
* max_executors_count=100,
* ),
* container_image=gcp.dataplex.TaskNotebookInfrastructureSpecContainerImageArgs(
* image="test-image",
* java_jars=["test-java-jars.jar"],
* python_packages=["gs://bucket-name/my/path/to/lib.tar.gz"],
* properties={
* "name": "wrench",
* "mass": "1.3kg",
* "count": "3",
* },
* ),
* vpc_network=gcp.dataplex.TaskNotebookInfrastructureSpecVpcNetworkArgs(
* network_tags=["test-network-tag"],
* network=default.id,
* ),
* ),
* file_uris=["gs://terraform-test/test.csv"],
* archive_uris=["gs://terraform-test/test.csv"],
* ),
* project="my-project-name")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* // VPC network
* var @default = new Gcp.Compute.Network("default", new()
* {
* Name = "tf-test-workstation-cluster_95154",
* AutoCreateSubnetworks = true,
* });
* var project = Gcp.Organizations.GetProject.Invoke();
* var exampleNotebook = new Gcp.DataPlex.Lake("example_notebook", new()
* {
* Name = "tf-test-lake_64336",
* Location = "us-central1",
* Project = "my-project-name",
* });
* var exampleNotebookTask = new Gcp.DataPlex.Task("example_notebook", new()
* {
* TaskId = "tf-test-task_34962",
* Location = "us-central1",
* Lake = exampleNotebook.Name,
* TriggerSpec = new Gcp.DataPlex.Inputs.TaskTriggerSpecArgs
* {
* Type = "RECURRING",
* Schedule = "1 * * * *",
* },
* ExecutionSpec = new Gcp.DataPlex.Inputs.TaskExecutionSpecArgs
* {
* ServiceAccount = $"{project.Apply(getProjectResult => getProjectResult.Number)}[email protected]",
* Args =
* {
* { "TASK_ARGS", "--output_location,gs://spark-job-jars-anrajitha/task-result, --output_format, json" },
* },
* },
* Notebook = new Gcp.DataPlex.Inputs.TaskNotebookArgs
* {
* Notebook = "gs://terraform-test/test-notebook.ipynb",
* InfrastructureSpec = new Gcp.DataPlex.Inputs.TaskNotebookInfrastructureSpecArgs
* {
* Batch = new Gcp.DataPlex.Inputs.TaskNotebookInfrastructureSpecBatchArgs
* {
* ExecutorsCount = 2,
* MaxExecutorsCount = 100,
* },
* ContainerImage = new Gcp.DataPlex.Inputs.TaskNotebookInfrastructureSpecContainerImageArgs
* {
* Image = "test-image",
* JavaJars = new[]
* {
* "test-java-jars.jar",
* },
* PythonPackages = new[]
* {
* "gs://bucket-name/my/path/to/lib.tar.gz",
* },
* Properties =
* {
* { "name", "wrench" },
* { "mass", "1.3kg" },
* { "count", "3" },
* },
* },
* VpcNetwork = new Gcp.DataPlex.Inputs.TaskNotebookInfrastructureSpecVpcNetworkArgs
* {
* NetworkTags = new[]
* {
* "test-network-tag",
* },
* Network = @default.Id,
* },
* },
* FileUris = new[]
* {
* "gs://terraform-test/test.csv",
* },
* ArchiveUris = new[]
* {
* "gs://terraform-test/test.csv",
* },
* },
* Project = "my-project-name",
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataplex"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* // VPC network
* _, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
* Name: pulumi.String("tf-test-workstation-cluster_95154"),
* AutoCreateSubnetworks: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* project, err := organizations.LookupProject(ctx, nil, nil)
* if err != nil {
* return err
* }
* exampleNotebook, err := dataplex.NewLake(ctx, "example_notebook", &dataplex.LakeArgs{
* Name: pulumi.String("tf-test-lake_64336"),
* Location: pulumi.String("us-central1"),
* Project: pulumi.String("my-project-name"),
* })
* if err != nil {
* return err
* }
* _, err = dataplex.NewTask(ctx, "example_notebook", &dataplex.TaskArgs{
* TaskId: pulumi.String("tf-test-task_34962"),
* Location: pulumi.String("us-central1"),
* Lake: exampleNotebook.Name,
* TriggerSpec: &dataplex.TaskTriggerSpecArgs{
* Type: pulumi.String("RECURRING"),
* Schedule: pulumi.String("1 * * * *"),
* },
* ExecutionSpec: &dataplex.TaskExecutionSpecArgs{
* ServiceAccount: pulumi.String(fmt.Sprintf("%[email protected]", project.Number)),
* Args: pulumi.StringMap{
* "TASK_ARGS": pulumi.String("--output_location,gs://spark-job-jars-anrajitha/task-result, --output_format, json"),
* },
* },
* Notebook: &dataplex.TaskNotebookArgs{
* Notebook: pulumi.String("gs://terraform-test/test-notebook.ipynb"),
* InfrastructureSpec: &dataplex.TaskNotebookInfrastructureSpecArgs{
* Batch: &dataplex.TaskNotebookInfrastructureSpecBatchArgs{
* ExecutorsCount: pulumi.Int(2),
* MaxExecutorsCount: pulumi.Int(100),
* },
* ContainerImage: &dataplex.TaskNotebookInfrastructureSpecContainerImageArgs{
* Image: pulumi.String("test-image"),
* JavaJars: pulumi.StringArray{
* pulumi.String("test-java-jars.jar"),
* },
* PythonPackages: pulumi.StringArray{
* pulumi.String("gs://bucket-name/my/path/to/lib.tar.gz"),
* },
* Properties: pulumi.StringMap{
* "name": pulumi.String("wrench"),
* "mass": pulumi.String("1.3kg"),
* "count": pulumi.String("3"),
* },
* },
* VpcNetwork: &dataplex.TaskNotebookInfrastructureSpecVpcNetworkArgs{
* NetworkTags: pulumi.StringArray{
* pulumi.String("test-network-tag"),
* },
* Network: _default.ID(),
* },
* },
* FileUris: pulumi.StringArray{
* pulumi.String("gs://terraform-test/test.csv"),
* },
* ArchiveUris: pulumi.StringArray{
* pulumi.String("gs://terraform-test/test.csv"),
* },
* },
* Project: pulumi.String("my-project-name"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.compute.Network;
* import com.pulumi.gcp.compute.NetworkArgs;
* import com.pulumi.gcp.organizations.OrganizationsFunctions;
* import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
* import com.pulumi.gcp.dataplex.Lake;
* import com.pulumi.gcp.dataplex.LakeArgs;
* import com.pulumi.gcp.dataplex.Task;
* import com.pulumi.gcp.dataplex.TaskArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskTriggerSpecArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskExecutionSpecArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskNotebookArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskNotebookInfrastructureSpecArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskNotebookInfrastructureSpecBatchArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskNotebookInfrastructureSpecContainerImageArgs;
* import com.pulumi.gcp.dataplex.inputs.TaskNotebookInfrastructureSpecVpcNetworkArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* // VPC network
* var default_ = new Network("default", NetworkArgs.builder()
* .name("tf-test-workstation-cluster_95154")
* .autoCreateSubnetworks(true)
* .build());
* final var project = OrganizationsFunctions.getProject();
* var exampleNotebook = new Lake("exampleNotebook", LakeArgs.builder()
* .name("tf-test-lake_64336")
* .location("us-central1")
* .project("my-project-name")
* .build());
* var exampleNotebookTask = new Task("exampleNotebookTask", TaskArgs.builder()
* .taskId("tf-test-task_34962")
* .location("us-central1")
* .lake(exampleNotebook.name())
* .triggerSpec(TaskTriggerSpecArgs.builder()
* .type("RECURRING")
* .schedule("1 * * * *")
* .build())
* .executionSpec(TaskExecutionSpecArgs.builder()
* .serviceAccount(String.format("%[email protected]", project.applyValue(getProjectResult -> getProjectResult.number())))
* .args(Map.of("TASK_ARGS", "--output_location,gs://spark-job-jars-anrajitha/task-result, --output_format, json"))
* .build())
* .notebook(TaskNotebookArgs.builder()
* .notebook("gs://terraform-test/test-notebook.ipynb")
* .infrastructureSpec(TaskNotebookInfrastructureSpecArgs.builder()
* .batch(TaskNotebookInfrastructureSpecBatchArgs.builder()
* .executorsCount(2)
* .maxExecutorsCount(100)
* .build())
* .containerImage(TaskNotebookInfrastructureSpecContainerImageArgs.builder()
* .image("test-image")
* .javaJars("test-java-jars.jar")
* .pythonPackages("gs://bucket-name/my/path/to/lib.tar.gz")
* .properties(Map.ofEntries(
* Map.entry("name", "wrench"),
* Map.entry("mass", "1.3kg"),
* Map.entry("count", "3")
* ))
* .build())
* .vpcNetwork(TaskNotebookInfrastructureSpecVpcNetworkArgs.builder()
* .networkTags("test-network-tag")
* .network(default_.id())
* .build())
* .build())
* .fileUris("gs://terraform-test/test.csv")
* .archiveUris("gs://terraform-test/test.csv")
* .build())
* .project("my-project-name")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* # VPC network
* default:
* type: gcp:compute:Network
* properties:
* name: tf-test-workstation-cluster_95154
* autoCreateSubnetworks: true
* exampleNotebook:
* type: gcp:dataplex:Lake
* name: example_notebook
* properties:
* name: tf-test-lake_64336
* location: us-central1
* project: my-project-name
* exampleNotebookTask:
* type: gcp:dataplex:Task
* name: example_notebook
* properties:
* taskId: tf-test-task_34962
* location: us-central1
* lake: ${exampleNotebook.name}
* triggerSpec:
* type: RECURRING
* schedule: 1 * * * *
* executionSpec:
* serviceAccount: ${project.number}[email protected]
* args:
* TASK_ARGS: --output_location,gs://spark-job-jars-anrajitha/task-result, --output_format, json
* notebook:
* notebook: gs://terraform-test/test-notebook.ipynb
* infrastructureSpec:
* batch:
* executorsCount: 2
* maxExecutorsCount: 100
* containerImage:
* image: test-image
* javaJars:
* - test-java-jars.jar
* pythonPackages:
* - gs://bucket-name/my/path/to/lib.tar.gz
* properties:
* name: wrench
* mass: 1.3kg
* count: '3'
* vpcNetwork:
* networkTags:
* - test-network-tag
* network: ${default.id}
* fileUris:
* - gs://terraform-test/test.csv
* archiveUris:
* - gs://terraform-test/test.csv
* project: my-project-name
* variables:
* project:
* fn::invoke:
* Function: gcp:organizations:getProject
* Arguments: {}
* ```
*
* ## Import
* Task can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/{{location}}/lakes/{{lake}}/tasks/{{task_id}}`
* * `{{project}}/{{location}}/{{lake}}/{{task_id}}`
* * `{{location}}/{{lake}}/{{task_id}}`
* When using the `pulumi import` command, Task can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:dataplex/task:Task default projects/{{project}}/locations/{{location}}/lakes/{{lake}}/tasks/{{task_id}}
* ```
* ```sh
* $ pulumi import gcp:dataplex/task:Task default {{project}}/{{location}}/{{lake}}/{{task_id}}
* ```
* ```sh
* $ pulumi import gcp:dataplex/task:Task default {{location}}/{{lake}}/{{task_id}}
* ```
*/
public class Task internal constructor(
override val javaResource: com.pulumi.gcp.dataplex.Task,
) : KotlinCustomResource(javaResource, TaskMapper) {
/**
* The time when the task was created.
*/
public val createTime: Output
get() = javaResource.createTime().applyValue({ args0 -> args0 })
/**
* User-provided description of the task.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* User friendly display name.
*/
public val displayName: Output?
get() = javaResource.displayName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
public val effectiveLabels: Output>
get() = javaResource.effectiveLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* Configuration for the cluster
* Structure is documented below.
*/
public val executionSpec: Output
get() = javaResource.executionSpec().applyValue({ args0 ->
args0.let({ args0 ->
taskExecutionSpecToKotlin(args0)
})
})
/**
* Configuration for the cluster
* Structure is documented below.
*/
public val executionStatuses: Output>
get() = javaResource.executionStatuses().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> taskExecutionStatusToKotlin(args0) })
})
})
/**
* User-defined labels for the task. **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.
*/
public val labels: Output>?
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The lake in which the task will be created in.
*/
public val lake: Output?
get() = javaResource.lake().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The location in which the task will be created in.
*/
public val location: Output?
get() = javaResource.location().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* (Output)
* The relative resource name of the job, of the form: projects/{project_number}/locations/{locationId}/lakes/{lakeId}/tasks/{taskId}/jobs/{jobId}.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of
* its memory over time.
*/
public val notebook: Output?
get() = javaResource.notebook().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
taskNotebookToKotlin(args0)
})
}).orElse(null)
})
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
public val pulumiLabels: Output>
get() = javaResource.pulumiLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of
* its memory over time.
*/
public val spark: Output?
get() = javaResource.spark().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
taskSparkToKotlin(args0)
})
}).orElse(null)
})
/**
* (Output)
* Execution state for the job.
*/
public val state: Output
get() = javaResource.state().applyValue({ args0 -> args0 })
/**
* The task Id of the task.
*/
public val taskId: Output?
get() = javaResource.taskId().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Configuration for the cluster
* Structure is documented below.
*/
public val triggerSpec: Output
get() = javaResource.triggerSpec().applyValue({ args0 ->
args0.let({ args0 ->
taskTriggerSpecToKotlin(args0)
})
})
/**
* (Output)
* System generated globally unique ID for the job.
*/
public val uid: Output
get() = javaResource.uid().applyValue({ args0 -> args0 })
/**
* (Output)
* Last update time of the status.
*/
public val updateTime: Output
get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}
public object TaskMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.dataplex.Task::class == javaResource::class
override fun map(javaResource: Resource): Task = Task(
javaResource as
com.pulumi.gcp.dataplex.Task,
)
}
/**
* @see [Task].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Task].
*/
public suspend fun task(name: String, block: suspend TaskResourceBuilder.() -> Unit): Task {
val builder = TaskResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Task].
* @param name The _unique_ name of the resulting resource.
*/
public fun task(name: String): Task {
val builder = TaskResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy