All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.datafactory.kotlin.TriggerTumblingWindow.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 6.15.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.datafactory.kotlin

import com.pulumi.azure.datafactory.kotlin.outputs.TriggerTumblingWindowPipeline
import com.pulumi.azure.datafactory.kotlin.outputs.TriggerTumblingWindowRetry
import com.pulumi.azure.datafactory.kotlin.outputs.TriggerTumblingWindowTriggerDependency
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
import com.pulumi.azure.datafactory.kotlin.outputs.TriggerTumblingWindowPipeline.Companion.toKotlin as triggerTumblingWindowPipelineToKotlin
import com.pulumi.azure.datafactory.kotlin.outputs.TriggerTumblingWindowRetry.Companion.toKotlin as triggerTumblingWindowRetryToKotlin
import com.pulumi.azure.datafactory.kotlin.outputs.TriggerTumblingWindowTriggerDependency.Companion.toKotlin as triggerTumblingWindowTriggerDependencyToKotlin

/**
 * Builder for [TriggerTumblingWindow].
 */
@PulumiTagMarker
public class TriggerTumblingWindowResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: TriggerTumblingWindowArgs = TriggerTumblingWindowArgs()

    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 TriggerTumblingWindowArgsBuilder.() -> Unit) {
        val builder = TriggerTumblingWindowArgsBuilder()
        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(): TriggerTumblingWindow {
        val builtJavaResource =
            com.pulumi.azure.datafactory.TriggerTumblingWindow(
                this.name,
                this.args.toJava(),
                this.opts.toJava(),
            )
        return TriggerTumblingWindow(builtJavaResource)
    }
}

/**
 * Manages a Tumbling Window Trigger inside an 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,
 * });
 * const exampleTriggerTumblingWindow = new azure.datafactory.TriggerTumblingWindow("example", {
 *     name: "example",
 *     dataFactoryId: exampleFactory.id,
 *     startTime: "2022-09-21T00:00:00Z",
 *     endTime: "2022-09-21T08:00:00Z",
 *     frequency: "Minute",
 *     interval: 15,
 *     delay: "16:00:00",
 *     annotations: [
 *         "example1",
 *         "example2",
 *         "example3",
 *     ],
 *     description: "example description",
 *     retry: {
 *         count: 1,
 *         interval: 30,
 *     },
 *     pipeline: {
 *         name: examplePipeline.name,
 *         parameters: {
 *             Env: "Prod",
 *         },
 *     },
 *     triggerDependencies: [{
 *         size: "24:00:00",
 *         offset: "-24:00:00",
 *     }],
 *     additionalProperties: {
 *         foo: "value1",
 *         bar: "value2",
 *     },
 * });
 * ```
 * ```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)
 * example_trigger_tumbling_window = azure.datafactory.TriggerTumblingWindow("example",
 *     name="example",
 *     data_factory_id=example_factory.id,
 *     start_time="2022-09-21T00:00:00Z",
 *     end_time="2022-09-21T08:00:00Z",
 *     frequency="Minute",
 *     interval=15,
 *     delay="16:00:00",
 *     annotations=[
 *         "example1",
 *         "example2",
 *         "example3",
 *     ],
 *     description="example description",
 *     retry={
 *         "count": 1,
 *         "interval": 30,
 *     },
 *     pipeline={
 *         "name": example_pipeline.name,
 *         "parameters": {
 *             "env": "Prod",
 *         },
 *     },
 *     trigger_dependencies=[{
 *         "size": "24:00:00",
 *         "offset": "-24:00:00",
 *     }],
 *     additional_properties={
 *         "foo": "value1",
 *         "bar": "value2",
 *     })
 * ```
 * ```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,
 *     });
 *     var exampleTriggerTumblingWindow = new Azure.DataFactory.TriggerTumblingWindow("example", new()
 *     {
 *         Name = "example",
 *         DataFactoryId = exampleFactory.Id,
 *         StartTime = "2022-09-21T00:00:00Z",
 *         EndTime = "2022-09-21T08:00:00Z",
 *         Frequency = "Minute",
 *         Interval = 15,
 *         Delay = "16:00:00",
 *         Annotations = new[]
 *         {
 *             "example1",
 *             "example2",
 *             "example3",
 *         },
 *         Description = "example description",
 *         Retry = new Azure.DataFactory.Inputs.TriggerTumblingWindowRetryArgs
 *         {
 *             Count = 1,
 *             Interval = 30,
 *         },
 *         Pipeline = new Azure.DataFactory.Inputs.TriggerTumblingWindowPipelineArgs
 *         {
 *             Name = examplePipeline.Name,
 *             Parameters =
 *             {
 *                 { "Env", "Prod" },
 *             },
 *         },
 *         TriggerDependencies = new[]
 *         {
 *             new Azure.DataFactory.Inputs.TriggerTumblingWindowTriggerDependencyArgs
 *             {
 *                 Size = "24:00:00",
 *                 Offset = "-24:00:00",
 *             },
 *         },
 *         AdditionalProperties =
 *         {
 *             { "foo", "value1" },
 *             { "bar", "value2" },
 *         },
 *     });
 * });
 * ```
 * ```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
 * 		}
 * 		examplePipeline, err := datafactory.NewPipeline(ctx, "example", &datafactory.PipelineArgs{
 * 			Name:          pulumi.String("example"),
 * 			DataFactoryId: exampleFactory.ID(),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = datafactory.NewTriggerTumblingWindow(ctx, "example", &datafactory.TriggerTumblingWindowArgs{
 * 			Name:          pulumi.String("example"),
 * 			DataFactoryId: exampleFactory.ID(),
 * 			StartTime:     pulumi.String("2022-09-21T00:00:00Z"),
 * 			EndTime:       pulumi.String("2022-09-21T08:00:00Z"),
 * 			Frequency:     pulumi.String("Minute"),
 * 			Interval:      pulumi.Int(15),
 * 			Delay:         pulumi.String("16:00:00"),
 * 			Annotations: pulumi.StringArray{
 * 				pulumi.String("example1"),
 * 				pulumi.String("example2"),
 * 				pulumi.String("example3"),
 * 			},
 * 			Description: pulumi.String("example description"),
 * 			Retry: &datafactory.TriggerTumblingWindowRetryArgs{
 * 				Count:    pulumi.Int(1),
 * 				Interval: pulumi.Int(30),
 * 			},
 * 			Pipeline: &datafactory.TriggerTumblingWindowPipelineArgs{
 * 				Name: examplePipeline.Name,
 * 				Parameters: pulumi.StringMap{
 * 					"Env": pulumi.String("Prod"),
 * 				},
 * 			},
 * 			TriggerDependencies: datafactory.TriggerTumblingWindowTriggerDependencyArray{
 * 				&datafactory.TriggerTumblingWindowTriggerDependencyArgs{
 * 					Size:   pulumi.String("24:00:00"),
 * 					Offset: pulumi.String("-24:00:00"),
 * 				},
 * 			},
 * 			AdditionalProperties: pulumi.StringMap{
 * 				"foo": pulumi.String("value1"),
 * 				"bar": pulumi.String("value2"),
 * 			},
 * 		})
 * 		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 com.pulumi.azure.datafactory.TriggerTumblingWindow;
 * import com.pulumi.azure.datafactory.TriggerTumblingWindowArgs;
 * import com.pulumi.azure.datafactory.inputs.TriggerTumblingWindowRetryArgs;
 * import com.pulumi.azure.datafactory.inputs.TriggerTumblingWindowPipelineArgs;
 * import com.pulumi.azure.datafactory.inputs.TriggerTumblingWindowTriggerDependencyArgs;
 * 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());
 *         var exampleTriggerTumblingWindow = new TriggerTumblingWindow("exampleTriggerTumblingWindow", TriggerTumblingWindowArgs.builder()
 *             .name("example")
 *             .dataFactoryId(exampleFactory.id())
 *             .startTime("2022-09-21T00:00:00Z")
 *             .endTime("2022-09-21T08:00:00Z")
 *             .frequency("Minute")
 *             .interval(15)
 *             .delay("16:00:00")
 *             .annotations(
 *                 "example1",
 *                 "example2",
 *                 "example3")
 *             .description("example description")
 *             .retry(TriggerTumblingWindowRetryArgs.builder()
 *                 .count(1)
 *                 .interval(30)
 *                 .build())
 *             .pipeline(TriggerTumblingWindowPipelineArgs.builder()
 *                 .name(examplePipeline.name())
 *                 .parameters(Map.of("Env", "Prod"))
 *                 .build())
 *             .triggerDependencies(TriggerTumblingWindowTriggerDependencyArgs.builder()
 *                 .size("24:00:00")
 *                 .offset("-24:00:00")
 *                 .build())
 *             .additionalProperties(Map.ofEntries(
 *                 Map.entry("foo", "value1"),
 *                 Map.entry("bar", "value2")
 *             ))
 *             .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}
 *   exampleTriggerTumblingWindow:
 *     type: azure:datafactory:TriggerTumblingWindow
 *     name: example
 *     properties:
 *       name: example
 *       dataFactoryId: ${exampleFactory.id}
 *       startTime: 2022-09-21T00:00:00Z
 *       endTime: 2022-09-21T08:00:00Z
 *       frequency: Minute
 *       interval: 15
 *       delay: 16:00:00
 *       annotations:
 *         - example1
 *         - example2
 *         - example3
 *       description: example description
 *       retry:
 *         count: 1
 *         interval: 30
 *       pipeline:
 *         name: ${examplePipeline.name}
 *         parameters:
 *           Env: Prod
 *       triggerDependencies:
 *         - size: 24:00:00
 *           offset: -24:00:00
 *       additionalProperties:
 *         foo: value1
 *         bar: value2
 * ```
 * 
 * ## Import
 * Data Factory Tumbling Window Trigger can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:datafactory/triggerTumblingWindow:TriggerTumblingWindow example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/triggers/example
 * ```
 */
public class TriggerTumblingWindow internal constructor(
    override val javaResource: com.pulumi.azure.datafactory.TriggerTumblingWindow,
) : KotlinCustomResource(javaResource, TriggerTumblingWindowMapper) {
    /**
     * Specifies if the Data Factory Tumbling Window Trigger is activated. Defaults to `true`.
     */
    public val activated: Output?
        get() = javaResource.activated().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * A map of additional properties to associate with the Data Factory Tumbling Window Trigger.
     */
    public val additionalProperties: Output>?
        get() = javaResource.additionalProperties().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
            }).orElse(null)
        })

    /**
     * List of tags that can be used for describing the Data Factory Tumbling Window Trigger.
     */
    public val annotations: Output>?
        get() = javaResource.annotations().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0
                })
            }).orElse(null)
        })

    /**
     * The ID of Data Factory in which to associate the Trigger with. Changing this forces a new resource.
     */
    public val dataFactoryId: Output
        get() = javaResource.dataFactoryId().applyValue({ args0 -> args0 })

    /**
     * Specifies how long the trigger waits before triggering new run. formatted as an `D.HH:MM:SS`.
     */
    public val delay: Output?
        get() = javaResource.delay().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The description for the Data Factory Tumbling Window Trigger.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies the end time of Tumbling Window, formatted as an RFC3339 string.
     */
    public val endTime: Output?
        get() = javaResource.endTime().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * Specifies the frequency of Tumbling Window. Possible values are `Hour`, `Minute` and `Month`. Changing this forces a new resource.
     */
    public val frequency: Output
        get() = javaResource.frequency().applyValue({ args0 -> args0 })

    /**
     * Specifies the interval of Tumbling Window. Changing this forces a new resource.
     */
    public val interval: Output
        get() = javaResource.interval().applyValue({ args0 -> args0 })

    /**
     * The max number for simultaneous trigger run fired by Tumbling Window. Possible values are between `1` and `50`. Defaults to `50`.
     */
    public val maxConcurrency: Output?
        get() = javaResource.maxConcurrency().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies the name of the Data Factory Tumbling Window Trigger. Changing this forces a new resource to be created.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * A `pipeline` block as defined below.
     */
    public val pipeline: Output
        get() = javaResource.pipeline().applyValue({ args0 ->
            args0.let({ args0 ->
                triggerTumblingWindowPipelineToKotlin(args0)
            })
        })

    /**
     * A `retry` block as defined below.
     */
    public val retry: Output?
        get() = javaResource.retry().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    triggerTumblingWindowRetryToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Specifies the start time of Tumbling Window, formatted as an RFC3339 string. Changing this forces a new resource.
     */
    public val startTime: Output
        get() = javaResource.startTime().applyValue({ args0 -> args0 })

    /**
     * One or more `trigger_dependency` block as defined below.
     */
    public val triggerDependencies: Output>?
        get() = javaResource.triggerDependencies().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 ->
                        triggerTumblingWindowTriggerDependencyToKotlin(args0)
                    })
                })
            }).orElse(null)
        })
}

public object TriggerTumblingWindowMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.datafactory.TriggerTumblingWindow::class == javaResource::class

    override fun map(javaResource: Resource): TriggerTumblingWindow =
        TriggerTumblingWindow(javaResource as com.pulumi.azure.datafactory.TriggerTumblingWindow)
}

/**
 * @see [TriggerTumblingWindow].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [TriggerTumblingWindow].
 */
public suspend fun triggerTumblingWindow(
    name: String,
    block: suspend TriggerTumblingWindowResourceBuilder.() -> Unit,
): TriggerTumblingWindow {
    val builder = TriggerTumblingWindowResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [TriggerTumblingWindow].
 * @param name The _unique_ name of the resulting resource.
 */
public fun triggerTumblingWindow(name: String): TriggerTumblingWindow {
    val builder = TriggerTumblingWindowResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy