Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.azure.datafactory.kotlin.Pipeline.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.datafactory.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.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [Pipeline].
*/
@PulumiTagMarker
public class PipelineResourceBuilder internal constructor() {
public var name: String? = null
public var args: PipelineArgs = PipelineArgs()
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 PipelineArgsBuilder.() -> Unit) {
val builder = PipelineArgsBuilder()
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(): Pipeline {
val builtJavaResource = com.pulumi.azure.datafactory.Pipeline(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Pipeline(builtJavaResource)
}
}
/**
* Manages a Pipeline inside a Azure Data Factory.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleFactory = new azure.datafactory.Factory("example", {
* name: "example",
* location: example.location,
* resourceGroupName: example.name,
* });
* const examplePipeline = new azure.datafactory.Pipeline("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_factory = azure.datafactory.Factory("example",
* name="example",
* location=example.location,
* resource_group_name=example.name)
* example_pipeline = azure.datafactory.Pipeline("example",
* name="example",
* data_factory_id=example_factory.id)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleFactory = new Azure.DataFactory.Factory("example", new()
* {
* Name = "example",
* Location = example.Location,
* ResourceGroupName = example.Name,
* });
* var examplePipeline = new Azure.DataFactory.Pipeline("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleFactory, err := datafactory.NewFactory(ctx, "example", &datafactory.FactoryArgs{
* Name: pulumi.String("example"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* })
* if err != nil {
* return err
* }
* _, err = datafactory.NewPipeline(ctx, "example", &datafactory.PipelineArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* })
* 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.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.datafactory.Factory;
* import com.pulumi.azure.datafactory.FactoryArgs;
* import com.pulumi.azure.datafactory.Pipeline;
* import com.pulumi.azure.datafactory.PipelineArgs;
* 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
* .name("example")
* .location(example.location())
* .resourceGroupName(example.name())
* .build());
* var examplePipeline = new Pipeline("examplePipeline", PipelineArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleFactory:
* type: azure:datafactory:Factory
* name: example
* properties:
* name: example
* location: ${example.location}
* resourceGroupName: ${example.name}
* examplePipeline:
* type: azure:datafactory:Pipeline
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* ```
*
* ### With Activities
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const test = new azure.datafactory.Pipeline("test", {
* name: "example",
* dataFactoryId: testAzurermDataFactory.id,
* variables: {
* bob: "item1",
* },
* activitiesJson: `[
* {
* "name": "Append variable1",
* "type": "AppendVariable",
* "dependsOn": [],
* "userProperties": [],
* "typeProperties": {
* "variableName": "bob",
* "value": "something"
* }
* }
* ]
* `,
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* test = azure.datafactory.Pipeline("test",
* name="example",
* data_factory_id=test_azurerm_data_factory["id"],
* variables={
* "bob": "item1",
* },
* activities_json="""[
* {
* "name": "Append variable1",
* "type": "AppendVariable",
* "dependsOn": [],
* "userProperties": [],
* "typeProperties": {
* "variableName": "bob",
* "value": "something"
* }
* }
* ]
* """)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var test = new Azure.DataFactory.Pipeline("test", new()
* {
* Name = "example",
* DataFactoryId = testAzurermDataFactory.Id,
* Variables =
* {
* { "bob", "item1" },
* },
* ActivitiesJson = @"[
* {
* ""name"": ""Append variable1"",
* ""type"": ""AppendVariable"",
* ""dependsOn"": [],
* ""userProperties"": [],
* ""typeProperties"": {
* ""variableName"": ""bob"",
* ""value"": ""something""
* }
* }
* ]
* ",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/datafactory"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := datafactory.NewPipeline(ctx, "test", &datafactory.PipelineArgs{
* Name: pulumi.String("example"),
* DataFactoryId: pulumi.Any(testAzurermDataFactory.Id),
* Variables: pulumi.StringMap{
* "bob": pulumi.String("item1"),
* },
* ActivitiesJson: pulumi.String(`[
* {
* "name": "Append variable1",
* "type": "AppendVariable",
* "dependsOn": [],
* "userProperties": [],
* "typeProperties": {
* "variableName": "bob",
* "value": "something"
* }
* }
* ]
* `),
* })
* 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.azure.datafactory.Pipeline;
* import com.pulumi.azure.datafactory.PipelineArgs;
* 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 test = new Pipeline("test", PipelineArgs.builder()
* .name("example")
* .dataFactoryId(testAzurermDataFactory.id())
* .variables(Map.of("bob", "item1"))
* .activitiesJson("""
* [
* {
* "name": "Append variable1",
* "type": "AppendVariable",
* "dependsOn": [],
* "userProperties": [],
* "typeProperties": {
* "variableName": "bob",
* "value": "something"
* }
* }
* ]
* """)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* test:
* type: azure:datafactory:Pipeline
* properties:
* name: example
* dataFactoryId: ${testAzurermDataFactory.id}
* variables:
* bob: item1
* activitiesJson: |
* [
* {
* "name": "Append variable1",
* "type": "AppendVariable",
* "dependsOn": [],
* "userProperties": [],
* "typeProperties": {
* "variableName": "bob",
* "value": "something"
* }
* }
* ]
* ```
*
* ## Import
* Data Factory Pipeline's can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:datafactory/pipeline:Pipeline example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/pipelines/example
* ```
*/
public class Pipeline internal constructor(
override val javaResource: com.pulumi.azure.datafactory.Pipeline,
) : KotlinCustomResource(javaResource, PipelineMapper) {
/**
* A JSON object that contains the activities that will be associated with the Data Factory Pipeline.
*/
public val activitiesJson: Output?
get() = javaResource.activitiesJson().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* List of tags that can be used for describing the Data Factory Pipeline.
*/
public val annotations: Output>?
get() = javaResource.annotations().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The max number of concurrent runs for the Data Factory Pipeline. Must be between `1` and `50`.
*/
public val concurrency: Output?
get() = javaResource.concurrency().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*/
public val dataFactoryId: Output
get() = javaResource.dataFactoryId().applyValue({ args0 -> args0 })
/**
* The description for the Data Factory Pipeline.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The folder that this Pipeline is in. If not specified, the Pipeline will appear at the root level.
*/
public val folder: Output?
get() = javaResource.folder().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The TimeSpan value after which an Azure Monitoring Metric is fired.
*/
public val moniterMetricsAfterDuration: Output?
get() = javaResource.moniterMetricsAfterDuration().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* A map of parameters to associate with the Data Factory Pipeline.
*/
public val parameters: Output>?
get() = javaResource.parameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* A map of variables to associate with the Data Factory Pipeline.
*/
public val variables: Output>?
get() = javaResource.variables().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
}
public object PipelineMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.datafactory.Pipeline::class == javaResource::class
override fun map(javaResource: Resource): Pipeline = Pipeline(
javaResource as
com.pulumi.azure.datafactory.Pipeline,
)
}
/**
* @see [Pipeline].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Pipeline].
*/
public suspend fun pipeline(name: String, block: suspend PipelineResourceBuilder.() -> Unit): Pipeline {
val builder = PipelineResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Pipeline].
* @param name The _unique_ name of the resulting resource.
*/
public fun pipeline(name: String): Pipeline {
val builder = PipelineResourceBuilder()
builder.name(name)
return builder.build()
}