com.pulumi.gcp.dataflow.kotlin.FlexTemplateJob.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.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.Any
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [FlexTemplateJob].
*/
@PulumiTagMarker
public class FlexTemplateJobResourceBuilder internal constructor() {
public var name: String? = null
public var args: FlexTemplateJobArgs = FlexTemplateJobArgs()
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 FlexTemplateJobArgsBuilder.() -> Unit) {
val builder = FlexTemplateJobArgsBuilder()
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(): FlexTemplateJob {
val builtJavaResource = com.pulumi.gcp.dataflow.FlexTemplateJob(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return FlexTemplateJob(builtJavaResource)
}
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const bigDataJob = new gcp.dataflow.FlexTemplateJob("big_data_job", {
* name: "dataflow-flextemplates-job",
* containerSpecGcsPath: "gs://my-bucket/templates/template.json",
* parameters: {
* inputSubscription: "messages",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* big_data_job = gcp.dataflow.FlexTemplateJob("big_data_job",
* name="dataflow-flextemplates-job",
* container_spec_gcs_path="gs://my-bucket/templates/template.json",
* parameters={
* "inputSubscription": "messages",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var bigDataJob = new Gcp.Dataflow.FlexTemplateJob("big_data_job", new()
* {
* Name = "dataflow-flextemplates-job",
* ContainerSpecGcsPath = "gs://my-bucket/templates/template.json",
* Parameters =
* {
* { "inputSubscription", "messages" },
* },
* });
* });
* ```
* ```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.NewFlexTemplateJob(ctx, "big_data_job", &dataflow.FlexTemplateJobArgs{
* Name: pulumi.String("dataflow-flextemplates-job"),
* ContainerSpecGcsPath: pulumi.String("gs://my-bucket/templates/template.json"),
* Parameters: pulumi.Map{
* "inputSubscription": pulumi.Any("messages"),
* },
* })
* 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.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) {
* var bigDataJob = new FlexTemplateJob("bigDataJob", FlexTemplateJobArgs.builder()
* .name("dataflow-flextemplates-job")
* .containerSpecGcsPath("gs://my-bucket/templates/template.json")
* .parameters(Map.of("inputSubscription", "messages"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* bigDataJob:
* type: gcp:dataflow:FlexTemplateJob
* name: big_data_job
* properties:
* name: dataflow-flextemplates-job
* containerSpecGcsPath: gs://my-bucket/templates/template.json
* parameters:
* inputSubscription: messages
* ```
*
* ## 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 provider / 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 "cancelled", but if a user sets `on_delete` 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
* This resource does not support import.
*/
public class FlexTemplateJob internal constructor(
override val javaResource: com.pulumi.gcp.dataflow.FlexTemplateJob,
) : KotlinCustomResource(javaResource, FlexTemplateJobMapper) {
/**
* List of experiments that should be used by the job. An example value is `["enable_stackdriver_agent_metrics"]`.
*/
public val additionalExperiments: Output>
get() = javaResource.additionalExperiments().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* The algorithm to use for autoscaling.
*/
public val autoscalingAlgorithm: Output
get() = javaResource.autoscalingAlgorithm().applyValue({ args0 -> args0 })
/**
* The GCS path to the Dataflow job Flex
* Template.
* - - -
*/
public val containerSpecGcsPath: Output
get() = javaResource.containerSpecGcsPath().applyValue({ args0 -> args0 })
public val effectiveLabels: Output>
get() = javaResource.effectiveLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* Immutable. Indicates if the job should use the streaming engine feature.
*/
public val enableStreamingEngine: Output?
get() = javaResource.enableStreamingEngine().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The configuration for VM IPs. Options are `"WORKER_IP_PUBLIC"` or `"WORKER_IP_PRIVATE"`.
*/
public val ipConfiguration: Output?
get() = javaResource.ipConfiguration().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The unique ID of this job.
*/
public val jobId: Output
get() = javaResource.jobId().applyValue({ args0 -> args0 })
/**
* The name for the Cloud KMS key for the job. Key format is: `projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY`
*/
public val kmsKeyName: Output
get() = javaResource.kmsKeyName().applyValue({ args0 -> args0 })
/**
* 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 marked as deprecated as the API does not currently
* support adding labels.
* **NOTE**: Google-provided Dataflow templates often provide default labels
* that begin with `goog-dataflow-provided`. Unless explicitly set in config, these
* labels will be ignored to prevent diffs on re-apply.
*/
public val labels: Output>?
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The machine type to use for launching the job. The default is n1-standard-1.
*/
public val launcherMachineType: Output
get() = javaResource.launcherMachineType().applyValue({ args0 -> args0 })
/**
* The machine type to use for the job.
*/
public val machineType: Output
get() = javaResource.machineType().applyValue({ args0 -> args0 })
/**
* Immutable. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
*/
public val maxWorkers: Output
get() = javaResource.maxWorkers().applyValue({ args0 -> args0 })
/**
* Immutable. A unique name for the resource, required by Dataflow.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The network to which VMs will be assigned. If it is not provided, "default" will be used.
*/
public val network: Output
get() = javaResource.network().applyValue({ args0 -> args0 })
/**
* Immutable. The initial number of Google Compute Engine instances for the job.
*/
public val numWorkers: Output
get() = javaResource.numWorkers().applyValue({ args0 -> args0 })
/**
* One of "drain" or "cancel". Specifies behavior of
* deletion during `pulumi destroy`. See above note.
*/
public val onDelete: Output?
get() = javaResource.onDelete().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* **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.
*/
public val parameters: Output>?
get() = javaResource.parameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The project in which the resource belongs. If it is not
* provided, the provider project is used.
*/
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()
})
/**
* Immutable. The region in which the created job should run.
*/
public val region: Output
get() = javaResource.region().applyValue({ args0 -> args0 })
/**
* Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.
*/
public val sdkContainerImage: Output
get() = javaResource.sdkContainerImage().applyValue({ args0 -> args0 })
/**
* Service account email to run the workers as. This should be just an email e.g. `[email protected]`. Do not include any `serviceAccount:` or other prefix.
*/
public val serviceAccountEmail: Output
get() = javaResource.serviceAccountEmail().applyValue({ args0 -> args0 })
public val skipWaitOnJobTermination: Output?
get() = javaResource.skipWaitOnJobTermination().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The Cloud Storage path to use for staging files. Must be a valid Cloud Storage URL, beginning with gs://.
*/
public val stagingLocation: Output
get() = javaResource.stagingLocation().applyValue({ args0 -> args0 })
/**
* The current state of the resource, selected from the [JobState enum](https://cloud.google.com/dataflow/docs/reference/rest/v1b3/projects.jobs#Job.JobState)
*/
public val state: Output
get() = javaResource.state().applyValue({ args0 -> args0 })
/**
* The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK".
*/
public val subnetwork: Output
get() = javaResource.subnetwork().applyValue({ args0 -> args0 })
/**
* The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.
*/
public val tempLocation: Output
get() = javaResource.tempLocation().applyValue({ args0 -> args0 })
/**
* 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.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.
*/
public val transformNameMapping: Output>?
get() = javaResource.transformNameMapping().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
}).orElse(null)
})
/**
* The type of this job, selected from the JobType enum.
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
}
public object FlexTemplateJobMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.dataflow.FlexTemplateJob::class == javaResource::class
override fun map(javaResource: Resource): FlexTemplateJob = FlexTemplateJob(
javaResource as
com.pulumi.gcp.dataflow.FlexTemplateJob,
)
}
/**
* @see [FlexTemplateJob].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [FlexTemplateJob].
*/
public suspend fun flexTemplateJob(
name: String,
block: suspend FlexTemplateJobResourceBuilder.() -> Unit,
): FlexTemplateJob {
val builder = FlexTemplateJobResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [FlexTemplateJob].
* @param name The _unique_ name of the resulting resource.
*/
public fun flexTemplateJob(name: String): FlexTemplateJob {
val builder = FlexTemplateJobResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy