com.pulumi.gcp.dataflow.kotlin.JobArgs.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.dataflow.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.dataflow.JobArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Any
import kotlin.Boolean
import kotlin.Int
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Creates a job on Dataflow, which is an implementation of Apache Beam running on Google Compute Engine. For more information see
* the official documentation for
* [Beam](https://beam.apache.org) and [Dataflow](https://cloud.google.com/dataflow/).
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const bigDataJob = new gcp.dataflow.Job("big_data_job", {
* name: "dataflow-job",
* templateGcsPath: "gs://my-bucket/templates/template_file",
* tempGcsLocation: "gs://my-bucket/tmp_dir",
* parameters: {
* foo: "bar",
* baz: "qux",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* big_data_job = gcp.dataflow.Job("big_data_job",
* name="dataflow-job",
* template_gcs_path="gs://my-bucket/templates/template_file",
* temp_gcs_location="gs://my-bucket/tmp_dir",
* parameters={
* "foo": "bar",
* "baz": "qux",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var bigDataJob = new Gcp.Dataflow.Job("big_data_job", new()
* {
* Name = "dataflow-job",
* TemplateGcsPath = "gs://my-bucket/templates/template_file",
* TempGcsLocation = "gs://my-bucket/tmp_dir",
* Parameters =
* {
* { "foo", "bar" },
* { "baz", "qux" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataflow"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := dataflow.NewJob(ctx, "big_data_job", &dataflow.JobArgs{
* Name: pulumi.String("dataflow-job"),
* TemplateGcsPath: pulumi.String("gs://my-bucket/templates/template_file"),
* TempGcsLocation: pulumi.String("gs://my-bucket/tmp_dir"),
* Parameters: pulumi.Map{
* "foo": pulumi.Any("bar"),
* "baz": pulumi.Any("qux"),
* },
* })
* 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.dataflow.Job;
* import com.pulumi.gcp.dataflow.JobArgs;
* 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) {
* var bigDataJob = new Job("bigDataJob", JobArgs.builder()
* .name("dataflow-job")
* .templateGcsPath("gs://my-bucket/templates/template_file")
* .tempGcsLocation("gs://my-bucket/tmp_dir")
* .parameters(Map.ofEntries(
* Map.entry("foo", "bar"),
* Map.entry("baz", "qux")
* ))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* bigDataJob:
* type: gcp:dataflow:Job
* name: big_data_job
* properties:
* name: dataflow-job
* templateGcsPath: gs://my-bucket/templates/template_file
* tempGcsLocation: gs://my-bucket/tmp_dir
* parameters:
* foo: bar
* baz: qux
* ```
*
* ### Streaming Job
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const topic = new gcp.pubsub.Topic("topic", {name: "dataflow-job1"});
* const bucket1 = new gcp.storage.Bucket("bucket1", {
* name: "tf-test-bucket1",
* location: "US",
* forceDestroy: true,
* });
* const bucket2 = new gcp.storage.Bucket("bucket2", {
* name: "tf-test-bucket2",
* location: "US",
* forceDestroy: true,
* });
* const pubsubStream = new gcp.dataflow.Job("pubsub_stream", {
* name: "tf-test-dataflow-job1",
* templateGcsPath: "gs://my-bucket/templates/template_file",
* tempGcsLocation: "gs://my-bucket/tmp_dir",
* enableStreamingEngine: true,
* parameters: {
* inputFilePattern: pulumi.interpolate`${bucket1.url}/*.json`,
* outputTopic: topic.id,
* },
* transformNameMapping: {
* name: "test_job",
* env: "test",
* },
* onDelete: "cancel",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* topic = gcp.pubsub.Topic("topic", name="dataflow-job1")
* bucket1 = gcp.storage.Bucket("bucket1",
* name="tf-test-bucket1",
* location="US",
* force_destroy=True)
* bucket2 = gcp.storage.Bucket("bucket2",
* name="tf-test-bucket2",
* location="US",
* force_destroy=True)
* pubsub_stream = gcp.dataflow.Job("pubsub_stream",
* name="tf-test-dataflow-job1",
* template_gcs_path="gs://my-bucket/templates/template_file",
* temp_gcs_location="gs://my-bucket/tmp_dir",
* enable_streaming_engine=True,
* parameters={
* "inputFilePattern": bucket1.url.apply(lambda url: f"{url}/*.json"),
* "outputTopic": topic.id,
* },
* transform_name_mapping={
* "name": "test_job",
* "env": "test",
* },
* on_delete="cancel")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var topic = new Gcp.PubSub.Topic("topic", new()
* {
* Name = "dataflow-job1",
* });
* var bucket1 = new Gcp.Storage.Bucket("bucket1", new()
* {
* Name = "tf-test-bucket1",
* Location = "US",
* ForceDestroy = true,
* });
* var bucket2 = new Gcp.Storage.Bucket("bucket2", new()
* {
* Name = "tf-test-bucket2",
* Location = "US",
* ForceDestroy = true,
* });
* var pubsubStream = new Gcp.Dataflow.Job("pubsub_stream", new()
* {
* Name = "tf-test-dataflow-job1",
* TemplateGcsPath = "gs://my-bucket/templates/template_file",
* TempGcsLocation = "gs://my-bucket/tmp_dir",
* EnableStreamingEngine = true,
* Parameters =
* {
* { "inputFilePattern", bucket1.Url.Apply(url => $"{url}/*.json") },
* { "outputTopic", topic.Id },
* },
* TransformNameMapping =
* {
* { "name", "test_job" },
* { "env", "test" },
* },
* OnDelete = "cancel",
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataflow"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/pubsub"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/storage"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* topic, err := pubsub.NewTopic(ctx, "topic", &pubsub.TopicArgs{
* Name: pulumi.String("dataflow-job1"),
* })
* if err != nil {
* return err
* }
* bucket1, err := storage.NewBucket(ctx, "bucket1", &storage.BucketArgs{
* Name: pulumi.String("tf-test-bucket1"),
* Location: pulumi.String("US"),
* ForceDestroy: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* _, err = storage.NewBucket(ctx, "bucket2", &storage.BucketArgs{
* Name: pulumi.String("tf-test-bucket2"),
* Location: pulumi.String("US"),
* ForceDestroy: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* _, err = dataflow.NewJob(ctx, "pubsub_stream", &dataflow.JobArgs{
* Name: pulumi.String("tf-test-dataflow-job1"),
* TemplateGcsPath: pulumi.String("gs://my-bucket/templates/template_file"),
* TempGcsLocation: pulumi.String("gs://my-bucket/tmp_dir"),
* EnableStreamingEngine: pulumi.Bool(true),
* Parameters: pulumi.Map{
* "inputFilePattern": bucket1.Url.ApplyT(func(url string) (string, error) {
* return fmt.Sprintf("%v/*.json", url), nil
* }).(pulumi.StringOutput),
* "outputTopic": topic.ID(),
* },
* TransformNameMapping: pulumi.Map{
* "name": pulumi.Any("test_job"),
* "env": pulumi.Any("test"),
* },
* OnDelete: pulumi.String("cancel"),
* })
* 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.pubsub.Topic;
* import com.pulumi.gcp.pubsub.TopicArgs;
* import com.pulumi.gcp.storage.Bucket;
* import com.pulumi.gcp.storage.BucketArgs;
* import com.pulumi.gcp.dataflow.Job;
* import com.pulumi.gcp.dataflow.JobArgs;
* 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) {
* var topic = new Topic("topic", TopicArgs.builder()
* .name("dataflow-job1")
* .build());
* var bucket1 = new Bucket("bucket1", BucketArgs.builder()
* .name("tf-test-bucket1")
* .location("US")
* .forceDestroy(true)
* .build());
* var bucket2 = new Bucket("bucket2", BucketArgs.builder()
* .name("tf-test-bucket2")
* .location("US")
* .forceDestroy(true)
* .build());
* var pubsubStream = new Job("pubsubStream", JobArgs.builder()
* .name("tf-test-dataflow-job1")
* .templateGcsPath("gs://my-bucket/templates/template_file")
* .tempGcsLocation("gs://my-bucket/tmp_dir")
* .enableStreamingEngine(true)
* .parameters(Map.ofEntries(
* Map.entry("inputFilePattern", bucket1.url().applyValue(url -> String.format("%s/*.json", url))),
* Map.entry("outputTopic", topic.id())
* ))
* .transformNameMapping(Map.ofEntries(
* Map.entry("name", "test_job"),
* Map.entry("env", "test")
* ))
* .onDelete("cancel")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* topic:
* type: gcp:pubsub:Topic
* properties:
* name: dataflow-job1
* bucket1:
* type: gcp:storage:Bucket
* properties:
* name: tf-test-bucket1
* location: US
* forceDestroy: true
* bucket2:
* type: gcp:storage:Bucket
* properties:
* name: tf-test-bucket2
* location: US
* forceDestroy: true
* pubsubStream:
* type: gcp:dataflow:Job
* name: pubsub_stream
* properties:
* name: tf-test-dataflow-job1
* templateGcsPath: gs://my-bucket/templates/template_file
* tempGcsLocation: gs://my-bucket/tmp_dir
* enableStreamingEngine: true
* parameters:
* inputFilePattern: ${bucket1.url}/*.json
* outputTopic: ${topic.id}
* transformNameMapping:
* name: test_job
* env: test
* onDelete: cancel
* ```
*
* ## Note on "destroy" / "apply"
* There are many types of Dataflow jobs. Some Dataflow jobs run constantly, getting new data from (e.g.) a GCS bucket, and outputting data continuously. Some jobs process a set amount of data then terminate. All jobs can fail while running due to programming errors or other issues. In this way, Dataflow jobs are different from most other Google resources.
* The Dataflow resource is considered 'existing' while it is in a nonterminal state. If it reaches a terminal state (e.g. 'FAILED', 'COMPLETE', 'CANCELLED'), it will be recreated on the next 'apply'. This is as expected for jobs which run continuously, but may surprise users who use this resource for other kinds of Dataflow jobs.
* A Dataflow job which is 'destroyed' may be "cancelled" or "drained". If "cancelled", the job terminates - any data written remains where it is, but no new data will be processed. If "drained", no new data will enter the pipeline, but any data currently in the pipeline will finish being processed. The default is "drain". When `on_delete` is set to `"drain"` in the configuration, you may experience a long wait for your `pulumi destroy` to complete.
* You can potentially short-circuit the wait by setting `skip_wait_on_job_termination` to `true`, but beware that unless you take active steps to ensure that the job `name` parameter changes between instances, the name will conflict and the launch of the new job will fail. One way to do this is with a random_id resource, for example:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as random from "@pulumi/random";
* const config = new pulumi.Config();
* const bigDataJobSubscriptionId = config.get("bigDataJobSubscriptionId") || "projects/myproject/subscriptions/messages";
* const bigDataJobNameSuffix = new random.RandomId("big_data_job_name_suffix", {
* byteLength: 4,
* keepers: {
* region: region,
* subscription_id: bigDataJobSubscriptionId,
* },
* });
* const bigDataJob = new gcp.dataflow.FlexTemplateJob("big_data_job", {
* name: pulumi.interpolate`dataflow-flextemplates-job-${bigDataJobNameSuffix.dec}`,
* region: region,
* containerSpecGcsPath: "gs://my-bucket/templates/template.json",
* skipWaitOnJobTermination: true,
* parameters: {
* inputSubscription: bigDataJobSubscriptionId,
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* import pulumi_random as random
* config = pulumi.Config()
* big_data_job_subscription_id = config.get("bigDataJobSubscriptionId")
* if big_data_job_subscription_id is None:
* big_data_job_subscription_id = "projects/myproject/subscriptions/messages"
* big_data_job_name_suffix = random.RandomId("big_data_job_name_suffix",
* byte_length=4,
* keepers={
* "region": region,
* "subscription_id": big_data_job_subscription_id,
* })
* big_data_job = gcp.dataflow.FlexTemplateJob("big_data_job",
* name=big_data_job_name_suffix.dec.apply(lambda dec: f"dataflow-flextemplates-job-{dec}"),
* region=region,
* container_spec_gcs_path="gs://my-bucket/templates/template.json",
* skip_wait_on_job_termination=True,
* parameters={
* "inputSubscription": big_data_job_subscription_id,
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* using Random = Pulumi.Random;
* return await Deployment.RunAsync(() =>
* {
* var config = new Config();
* var bigDataJobSubscriptionId = config.Get("bigDataJobSubscriptionId") ?? "projects/myproject/subscriptions/messages";
* var bigDataJobNameSuffix = new Random.RandomId("big_data_job_name_suffix", new()
* {
* ByteLength = 4,
* Keepers =
* {
* { "region", region },
* { "subscription_id", bigDataJobSubscriptionId },
* },
* });
* var bigDataJob = new Gcp.Dataflow.FlexTemplateJob("big_data_job", new()
* {
* Name = bigDataJobNameSuffix.Dec.Apply(dec => $"dataflow-flextemplates-job-{dec}"),
* Region = region,
* ContainerSpecGcsPath = "gs://my-bucket/templates/template.json",
* SkipWaitOnJobTermination = true,
* Parameters =
* {
* { "inputSubscription", bigDataJobSubscriptionId },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataflow"
* "github.com/pulumi/pulumi-random/sdk/v4/go/random"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* cfg := config.New(ctx, "")
* bigDataJobSubscriptionId := "projects/myproject/subscriptions/messages"
* if param := cfg.Get("bigDataJobSubscriptionId"); param != "" {
* bigDataJobSubscriptionId = param
* }
* bigDataJobNameSuffix, err := random.NewRandomId(ctx, "big_data_job_name_suffix", &random.RandomIdArgs{
* ByteLength: pulumi.Int(4),
* Keepers: pulumi.StringMap{
* "region": pulumi.Any(region),
* "subscription_id": pulumi.String(bigDataJobSubscriptionId),
* },
* })
* if err != nil {
* return err
* }
* _, err = dataflow.NewFlexTemplateJob(ctx, "big_data_job", &dataflow.FlexTemplateJobArgs{
* Name: bigDataJobNameSuffix.Dec.ApplyT(func(dec string) (string, error) {
* return fmt.Sprintf("dataflow-flextemplates-job-%v", dec), nil
* }).(pulumi.StringOutput),
* Region: pulumi.Any(region),
* ContainerSpecGcsPath: pulumi.String("gs://my-bucket/templates/template.json"),
* SkipWaitOnJobTermination: pulumi.Bool(true),
* Parameters: pulumi.Map{
* "inputSubscription": pulumi.String(bigDataJobSubscriptionId),
* },
* })
* 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.random.RandomId;
* import com.pulumi.random.RandomIdArgs;
* import com.pulumi.gcp.dataflow.FlexTemplateJob;
* import com.pulumi.gcp.dataflow.FlexTemplateJobArgs;
* 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 config = ctx.config();
* final var bigDataJobSubscriptionId = config.get("bigDataJobSubscriptionId").orElse("projects/myproject/subscriptions/messages");
* var bigDataJobNameSuffix = new RandomId("bigDataJobNameSuffix", RandomIdArgs.builder()
* .byteLength(4)
* .keepers(Map.ofEntries(
* Map.entry("region", region),
* Map.entry("subscription_id", bigDataJobSubscriptionId)
* ))
* .build());
* var bigDataJob = new FlexTemplateJob("bigDataJob", FlexTemplateJobArgs.builder()
* .name(bigDataJobNameSuffix.dec().applyValue(dec -> String.format("dataflow-flextemplates-job-%s", dec)))
* .region(region)
* .containerSpecGcsPath("gs://my-bucket/templates/template.json")
* .skipWaitOnJobTermination(true)
* .parameters(Map.of("inputSubscription", bigDataJobSubscriptionId))
* .build());
* }
* }
* ```
* ```yaml
* configuration:
* bigDataJobSubscriptionId:
* type: string
* default: projects/myproject/subscriptions/messages
* resources:
* bigDataJobNameSuffix:
* type: random:RandomId
* name: big_data_job_name_suffix
* properties:
* byteLength: 4
* keepers:
* region: ${region}
* subscription_id: ${bigDataJobSubscriptionId}
* bigDataJob:
* type: gcp:dataflow:FlexTemplateJob
* name: big_data_job
* properties:
* name: dataflow-flextemplates-job-${bigDataJobNameSuffix.dec}
* region: ${region}
* containerSpecGcsPath: gs://my-bucket/templates/template.json
* skipWaitOnJobTermination: true
* parameters:
* inputSubscription: ${bigDataJobSubscriptionId}
* ```
*
* ## Import
* Dataflow jobs can be imported using the job `id` e.g.
* * `{{id}}`
* When using the `pulumi import` command, dataflow jobs can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:dataflow/job:Job default {{id}}
* ```
* @property additionalExperiments List of experiments that should be used by the job. An example value is `["enable_stackdriver_agent_metrics"]`.
* @property enableStreamingEngine Enable/disable the use of [Streaming Engine](https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#streaming-engine) for the job. Note that Streaming Engine is enabled by default for pipelines developed against the Beam SDK for Python v2.21.0 or later when using Python 3.
* @property ipConfiguration The configuration for VM IPs. Options are `"WORKER_IP_PUBLIC"` or `"WORKER_IP_PRIVATE"`.
* @property kmsKeyName The name for the Cloud KMS key for the job. Key format is: `projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY`
* @property labels User labels to be specified for the job. Keys and values should follow the restrictions
* specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page.
* **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.
* @property machineType The machine type to use for the job.
* @property maxWorkers The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.
* @property name A unique name for the resource, required by Dataflow.
* @property network The network to which VMs will be assigned. If it is not provided, "default" will be used.
* @property onDelete One of "drain" or "cancel". Specifies behavior of deletion during `pulumi destroy`. See above note.
* @property parameters **Template specific** Key/Value pairs to be forwarded to the pipeline's options; keys are
* case-sensitive based on the language on which the pipeline is coded, mostly Java.
* **Note**: do not configure Dataflow options here in parameters.
* @property project The project in which the resource belongs. If it is not provided, the provider project is used.
* @property region The region in which the created job should run.
* @property serviceAccountEmail The Service Account email used to create the job. This should be just an email e.g. `[email protected]`. Do not include any `serviceAccount:` or other prefix.
* @property skipWaitOnJobTermination If set to `true`, Pulumi will treat `DRAINING` and `CANCELLING` as terminal states when deleting the resource, and will remove the resource from Pulumi state and move on. See above note.
* @property subnetwork The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK". If the [subnetwork is located in a Shared VPC network](https://cloud.google.com/dataflow/docs/guides/specifying-networks#shared), you must use the complete URL. For example `"googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME"`
* @property tempGcsLocation A writeable location on GCS for the Dataflow job to dump its temporary data.
* - - -
* @property templateGcsPath The GCS path to the Dataflow job template.
* @property transformNameMapping Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced with the corresponding name prefixes of the new job. This field is not used outside of update.
* @property zone The zone in which the created job should run. If it is not provided, the provider zone is used.
* */*/*/*/*/*/
*/
public data class JobArgs(
public val additionalExperiments: Output>? = null,
public val enableStreamingEngine: Output? = null,
public val ipConfiguration: Output? = null,
public val kmsKeyName: Output? = null,
public val labels: Output>? = null,
public val machineType: Output? = null,
public val maxWorkers: Output? = null,
public val name: Output? = null,
public val network: Output? = null,
public val onDelete: Output? = null,
public val parameters: Output>? = null,
public val project: Output? = null,
public val region: Output? = null,
public val serviceAccountEmail: Output? = null,
public val skipWaitOnJobTermination: Output? = null,
public val subnetwork: Output? = null,
public val tempGcsLocation: Output? = null,
public val templateGcsPath: Output? = null,
public val transformNameMapping: Output>? = null,
public val zone: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.dataflow.JobArgs = com.pulumi.gcp.dataflow.JobArgs.builder()
.additionalExperiments(additionalExperiments?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.enableStreamingEngine(enableStreamingEngine?.applyValue({ args0 -> args0 }))
.ipConfiguration(ipConfiguration?.applyValue({ args0 -> args0 }))
.kmsKeyName(kmsKeyName?.applyValue({ args0 -> args0 }))
.labels(labels?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.machineType(machineType?.applyValue({ args0 -> args0 }))
.maxWorkers(maxWorkers?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.network(network?.applyValue({ args0 -> args0 }))
.onDelete(onDelete?.applyValue({ args0 -> args0 }))
.parameters(
parameters?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.project(project?.applyValue({ args0 -> args0 }))
.region(region?.applyValue({ args0 -> args0 }))
.serviceAccountEmail(serviceAccountEmail?.applyValue({ args0 -> args0 }))
.skipWaitOnJobTermination(skipWaitOnJobTermination?.applyValue({ args0 -> args0 }))
.subnetwork(subnetwork?.applyValue({ args0 -> args0 }))
.tempGcsLocation(tempGcsLocation?.applyValue({ args0 -> args0 }))
.templateGcsPath(templateGcsPath?.applyValue({ args0 -> args0 }))
.transformNameMapping(
transformNameMapping?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.zone(zone?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [JobArgs].
*/
@PulumiTagMarker
public class JobArgsBuilder internal constructor() {
private var additionalExperiments: Output>? = null
private var enableStreamingEngine: Output? = null
private var ipConfiguration: Output? = null
private var kmsKeyName: Output? = null
private var labels: Output>? = null
private var machineType: Output? = null
private var maxWorkers: Output? = null
private var name: Output? = null
private var network: Output? = null
private var onDelete: Output? = null
private var parameters: Output>? = null
private var project: Output? = null
private var region: Output? = null
private var serviceAccountEmail: Output? = null
private var skipWaitOnJobTermination: Output? = null
private var subnetwork: Output? = null
private var tempGcsLocation: Output? = null
private var templateGcsPath: Output? = null
private var transformNameMapping: Output>? = null
private var zone: Output? = null
/**
* @param value List of experiments that should be used by the job. An example value is `["enable_stackdriver_agent_metrics"]`.
*/
@JvmName("hpsxrbwmwjwykfee")
public suspend fun additionalExperiments(`value`: Output>) {
this.additionalExperiments = value
}
@JvmName("uvtpvqnllnvpolvu")
public suspend fun additionalExperiments(vararg values: Output) {
this.additionalExperiments = Output.all(values.asList())
}
/**
* @param values List of experiments that should be used by the job. An example value is `["enable_stackdriver_agent_metrics"]`.
*/
@JvmName("xkoyiicstxgqybih")
public suspend fun additionalExperiments(values: List>) {
this.additionalExperiments = Output.all(values)
}
/**
* @param value Enable/disable the use of [Streaming Engine](https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#streaming-engine) for the job. Note that Streaming Engine is enabled by default for pipelines developed against the Beam SDK for Python v2.21.0 or later when using Python 3.
*/
@JvmName("egspvqeehraxutyb")
public suspend fun enableStreamingEngine(`value`: Output) {
this.enableStreamingEngine = value
}
/**
* @param value The configuration for VM IPs. Options are `"WORKER_IP_PUBLIC"` or `"WORKER_IP_PRIVATE"`.
*/
@JvmName("hvessisssujrfqmt")
public suspend fun ipConfiguration(`value`: Output) {
this.ipConfiguration = value
}
/**
* @param value The name for the Cloud KMS key for the job. Key format is: `projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY`
*/
@JvmName("klmjabtiqipwufyn")
public suspend fun kmsKeyName(`value`: Output) {
this.kmsKeyName = value
}
/**
* @param value User labels to be specified for the job. Keys and values should follow the restrictions
* specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page.
* **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.
*/
@JvmName("nrgwurlptkbbqbmb")
public suspend fun labels(`value`: Output>) {
this.labels = value
}
/**
* @param value The machine type to use for the job.
*/
@JvmName("onbtuudmcxqthytn")
public suspend fun machineType(`value`: Output) {
this.machineType = value
}
/**
* @param value The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.
*/
@JvmName("pwslsnykkmixhsca")
public suspend fun maxWorkers(`value`: Output) {
this.maxWorkers = value
}
/**
* @param value A unique name for the resource, required by Dataflow.
*/
@JvmName("foanodunxwodagmg")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The network to which VMs will be assigned. If it is not provided, "default" will be used.
*/
@JvmName("cuiqtxewplhddukn")
public suspend fun network(`value`: Output) {
this.network = value
}
/**
* @param value One of "drain" or "cancel". Specifies behavior of deletion during `pulumi destroy`. See above note.
*/
@JvmName("ssjgbbxtbmmcqjac")
public suspend fun onDelete(`value`: Output) {
this.onDelete = value
}
/**
* @param value **Template specific** Key/Value pairs to be forwarded to the pipeline's options; keys are
* case-sensitive based on the language on which the pipeline is coded, mostly Java.
* **Note**: do not configure Dataflow options here in parameters.
*/
@JvmName("scqwxydycwlswkwv")
public suspend fun parameters(`value`: Output>) {
this.parameters = value
}
/**
* @param value The project in which the resource belongs. If it is not provided, the provider project is used.
*/
@JvmName("nbwasicgijrslvyo")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value The region in which the created job should run.
*/
@JvmName("jedyjscnpohesvby")
public suspend fun region(`value`: Output) {
this.region = value
}
/**
* @param value The Service Account email used to create the job. This should be just an email e.g. `[email protected]`. Do not include any `serviceAccount:` or other prefix.
*/
@JvmName("drbailrqpvosqoql")
public suspend fun serviceAccountEmail(`value`: Output) {
this.serviceAccountEmail = value
}
/**
* @param value If set to `true`, Pulumi will treat `DRAINING` and `CANCELLING` as terminal states when deleting the resource, and will remove the resource from Pulumi state and move on. See above note.
*/
@JvmName("geoyypennvkqugny")
public suspend fun skipWaitOnJobTermination(`value`: Output) {
this.skipWaitOnJobTermination = value
}
/**
* @param value The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK". If the [subnetwork is located in a Shared VPC network](https://cloud.google.com/dataflow/docs/guides/specifying-networks#shared), you must use the complete URL. For example `"googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME"`
*/
@JvmName("jhjnkqdekrrfbspd")
public suspend fun subnetwork(`value`: Output) {
this.subnetwork = value
}
/**
* @param value A writeable location on GCS for the Dataflow job to dump its temporary data.
* - - -
*/
@JvmName("xsvyygswgnlyvkpy")
public suspend fun tempGcsLocation(`value`: Output) {
this.tempGcsLocation = value
}
/**
* @param value The GCS path to the Dataflow job template.
*/
@JvmName("vfgpltrfsgptolyb")
public suspend fun templateGcsPath(`value`: Output) {
this.templateGcsPath = value
}
/**
* @param value Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced with the corresponding name prefixes of the new job. This field is not used outside of update.
*/
@JvmName("ctjvuoeustkxsdwn")
public suspend fun transformNameMapping(`value`: Output>) {
this.transformNameMapping = value
}
/**
* @param value The zone in which the created job should run. If it is not provided, the provider zone is used.
*/
@JvmName("qerwfsqtnfbxodqs")
public suspend fun zone(`value`: Output) {
this.zone = value
}
/**
* @param value List of experiments that should be used by the job. An example value is `["enable_stackdriver_agent_metrics"]`.
*/
@JvmName("wnphqwsijslitlih")
public suspend fun additionalExperiments(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.additionalExperiments = mapped
}
/**
* @param values List of experiments that should be used by the job. An example value is `["enable_stackdriver_agent_metrics"]`.
*/
@JvmName("mpovuipwlvibgjri")
public suspend fun additionalExperiments(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.additionalExperiments = mapped
}
/**
* @param value Enable/disable the use of [Streaming Engine](https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#streaming-engine) for the job. Note that Streaming Engine is enabled by default for pipelines developed against the Beam SDK for Python v2.21.0 or later when using Python 3.
*/
@JvmName("wwovuljxotjypuhw")
public suspend fun enableStreamingEngine(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enableStreamingEngine = mapped
}
/**
* @param value The configuration for VM IPs. Options are `"WORKER_IP_PUBLIC"` or `"WORKER_IP_PRIVATE"`.
*/
@JvmName("kddoiaebslhvnaif")
public suspend fun ipConfiguration(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.ipConfiguration = mapped
}
/**
* @param value The name for the Cloud KMS key for the job. Key format is: `projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY`
*/
@JvmName("njsqdtfvtmdajwpg")
public suspend fun kmsKeyName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.kmsKeyName = mapped
}
/**
* @param value User labels to be specified for the job. Keys and values should follow the restrictions
* specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page.
* **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.
*/
@JvmName("fgahcpkfwqaholxl")
public suspend fun labels(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param values User labels to be specified for the job. Keys and values should follow the restrictions
* specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page.
* **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.
*/
@JvmName("aqjnqrtnujevhteu")
public fun labels(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param value The machine type to use for the job.
*/
@JvmName("sqepruestnrdufcu")
public suspend fun machineType(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.machineType = mapped
}
/**
* @param value The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.
*/
@JvmName("nlxbcayemcvokfhu")
public suspend fun maxWorkers(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.maxWorkers = mapped
}
/**
* @param value A unique name for the resource, required by Dataflow.
*/
@JvmName("lrnadwwmwnsdndhb")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The network to which VMs will be assigned. If it is not provided, "default" will be used.
*/
@JvmName("vyxmohqapmgiyvsh")
public suspend fun network(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.network = mapped
}
/**
* @param value One of "drain" or "cancel". Specifies behavior of deletion during `pulumi destroy`. See above note.
*/
@JvmName("dyqagkkfdjrrtfau")
public suspend fun onDelete(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.onDelete = mapped
}
/**
* @param value **Template specific** Key/Value pairs to be forwarded to the pipeline's options; keys are
* case-sensitive based on the language on which the pipeline is coded, mostly Java.
* **Note**: do not configure Dataflow options here in parameters.
*/
@JvmName("edymcuhyesgjwsee")
public suspend fun parameters(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param values **Template specific** Key/Value pairs to be forwarded to the pipeline's options; keys are
* case-sensitive based on the language on which the pipeline is coded, mostly Java.
* **Note**: do not configure Dataflow options here in parameters.
*/
@JvmName("shebpvigwipnhuji")
public fun parameters(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.parameters = mapped
}
/**
* @param value The project in which the resource belongs. If it is not provided, the provider project is used.
*/
@JvmName("dpykiptteiyyhmje")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value The region in which the created job should run.
*/
@JvmName("nwhwanypaqabcsix")
public suspend fun region(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.region = mapped
}
/**
* @param value The Service Account email used to create the job. This should be just an email e.g. `[email protected]`. Do not include any `serviceAccount:` or other prefix.
*/
@JvmName("ladkulnljhdhdpvy")
public suspend fun serviceAccountEmail(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.serviceAccountEmail = mapped
}
/**
* @param value If set to `true`, Pulumi will treat `DRAINING` and `CANCELLING` as terminal states when deleting the resource, and will remove the resource from Pulumi state and move on. See above note.
*/
@JvmName("dyrhjbbsqxaruimr")
public suspend fun skipWaitOnJobTermination(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.skipWaitOnJobTermination = mapped
}
/**
* @param value The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK". If the [subnetwork is located in a Shared VPC network](https://cloud.google.com/dataflow/docs/guides/specifying-networks#shared), you must use the complete URL. For example `"googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME"`
*/
@JvmName("jfooylexhnvddfwn")
public suspend fun subnetwork(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.subnetwork = mapped
}
/**
* @param value A writeable location on GCS for the Dataflow job to dump its temporary data.
* - - -
*/
@JvmName("bjtuhryqyoegtsfd")
public suspend fun tempGcsLocation(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tempGcsLocation = mapped
}
/**
* @param value The GCS path to the Dataflow job template.
*/
@JvmName("bejauvbhaxwemekh")
public suspend fun templateGcsPath(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.templateGcsPath = mapped
}
/**
* @param value Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced with the corresponding name prefixes of the new job. This field is not used outside of update.
*/
@JvmName("hpkhadrivveuxcmn")
public suspend fun transformNameMapping(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.transformNameMapping = mapped
}
/**
* @param values Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced with the corresponding name prefixes of the new job. This field is not used outside of update.
*/
@JvmName("fetoikqpsabmixic")
public fun transformNameMapping(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.transformNameMapping = mapped
}
/**
* @param value The zone in which the created job should run. If it is not provided, the provider zone is used.
*/
@JvmName("wmlrgqeslgojdifu")
public suspend fun zone(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.zone = mapped
}
internal fun build(): JobArgs = JobArgs(
additionalExperiments = additionalExperiments,
enableStreamingEngine = enableStreamingEngine,
ipConfiguration = ipConfiguration,
kmsKeyName = kmsKeyName,
labels = labels,
machineType = machineType,
maxWorkers = maxWorkers,
name = name,
network = network,
onDelete = onDelete,
parameters = parameters,
project = project,
region = region,
serviceAccountEmail = serviceAccountEmail,
skipWaitOnJobTermination = skipWaitOnJobTermination,
subnetwork = subnetwork,
tempGcsLocation = tempGcsLocation,
templateGcsPath = templateGcsPath,
transformNameMapping = transformNameMapping,
zone = zone,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy