com.pulumi.azure.datafactory.kotlin.DatasetDelimitedText.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.datafactory.kotlin
import com.pulumi.azure.datafactory.kotlin.outputs.DatasetDelimitedTextAzureBlobFsLocation
import com.pulumi.azure.datafactory.kotlin.outputs.DatasetDelimitedTextAzureBlobStorageLocation
import com.pulumi.azure.datafactory.kotlin.outputs.DatasetDelimitedTextHttpServerLocation
import com.pulumi.azure.datafactory.kotlin.outputs.DatasetDelimitedTextSchemaColumn
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.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.azure.datafactory.kotlin.outputs.DatasetDelimitedTextAzureBlobFsLocation.Companion.toKotlin as datasetDelimitedTextAzureBlobFsLocationToKotlin
import com.pulumi.azure.datafactory.kotlin.outputs.DatasetDelimitedTextAzureBlobStorageLocation.Companion.toKotlin as datasetDelimitedTextAzureBlobStorageLocationToKotlin
import com.pulumi.azure.datafactory.kotlin.outputs.DatasetDelimitedTextHttpServerLocation.Companion.toKotlin as datasetDelimitedTextHttpServerLocationToKotlin
import com.pulumi.azure.datafactory.kotlin.outputs.DatasetDelimitedTextSchemaColumn.Companion.toKotlin as datasetDelimitedTextSchemaColumnToKotlin
/**
* Builder for [DatasetDelimitedText].
*/
@PulumiTagMarker
public class DatasetDelimitedTextResourceBuilder internal constructor() {
public var name: String? = null
public var args: DatasetDelimitedTextArgs = DatasetDelimitedTextArgs()
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 DatasetDelimitedTextArgsBuilder.() -> Unit) {
val builder = DatasetDelimitedTextArgsBuilder()
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(): DatasetDelimitedText {
val builtJavaResource =
com.pulumi.azure.datafactory.DatasetDelimitedText(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return DatasetDelimitedText(builtJavaResource)
}
}
/**
* Manages an Azure Delimited Text Dataset 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 exampleLinkedServiceWeb = new azure.datafactory.LinkedServiceWeb("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* authenticationType: "Anonymous",
* url: "https://www.bing.com",
* });
* const exampleDatasetDelimitedText = new azure.datafactory.DatasetDelimitedText("example", {
* name: "example",
* dataFactoryId: exampleFactory.id,
* linkedServiceName: exampleLinkedServiceWeb.name,
* httpServerLocation: {
* relativeUrl: "http://www.bing.com",
* path: "foo/bar/",
* filename: "fizz.txt",
* },
* columnDelimiter: ",",
* rowDelimiter: "NEW",
* encoding: "UTF-8",
* quoteCharacter: "x",
* escapeCharacter: "f",
* firstRowAsHeader: true,
* nullValue: "NULL",
* });
* ```
* ```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_linked_service_web = azure.datafactory.LinkedServiceWeb("example",
* name="example",
* data_factory_id=example_factory.id,
* authentication_type="Anonymous",
* url="https://www.bing.com")
* example_dataset_delimited_text = azure.datafactory.DatasetDelimitedText("example",
* name="example",
* data_factory_id=example_factory.id,
* linked_service_name=example_linked_service_web.name,
* http_server_location=azure.datafactory.DatasetDelimitedTextHttpServerLocationArgs(
* relative_url="http://www.bing.com",
* path="foo/bar/",
* filename="fizz.txt",
* ),
* column_delimiter=",",
* row_delimiter="NEW",
* encoding="UTF-8",
* quote_character="x",
* escape_character="f",
* first_row_as_header=True,
* null_value="NULL")
* ```
* ```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 exampleLinkedServiceWeb = new Azure.DataFactory.LinkedServiceWeb("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* AuthenticationType = "Anonymous",
* Url = "https://www.bing.com",
* });
* var exampleDatasetDelimitedText = new Azure.DataFactory.DatasetDelimitedText("example", new()
* {
* Name = "example",
* DataFactoryId = exampleFactory.Id,
* LinkedServiceName = exampleLinkedServiceWeb.Name,
* HttpServerLocation = new Azure.DataFactory.Inputs.DatasetDelimitedTextHttpServerLocationArgs
* {
* RelativeUrl = "http://www.bing.com",
* Path = "foo/bar/",
* Filename = "fizz.txt",
* },
* ColumnDelimiter = ",",
* RowDelimiter = "NEW",
* Encoding = "UTF-8",
* QuoteCharacter = "x",
* EscapeCharacter = "f",
* FirstRowAsHeader = true,
* NullValue = "NULL",
* });
* });
* ```
* ```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
* }
* exampleLinkedServiceWeb, err := datafactory.NewLinkedServiceWeb(ctx, "example", &datafactory.LinkedServiceWebArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* AuthenticationType: pulumi.String("Anonymous"),
* Url: pulumi.String("https://www.bing.com"),
* })
* if err != nil {
* return err
* }
* _, err = datafactory.NewDatasetDelimitedText(ctx, "example", &datafactory.DatasetDelimitedTextArgs{
* Name: pulumi.String("example"),
* DataFactoryId: exampleFactory.ID(),
* LinkedServiceName: exampleLinkedServiceWeb.Name,
* HttpServerLocation: &datafactory.DatasetDelimitedTextHttpServerLocationArgs{
* RelativeUrl: pulumi.String("http://www.bing.com"),
* Path: pulumi.String("foo/bar/"),
* Filename: pulumi.String("fizz.txt"),
* },
* ColumnDelimiter: pulumi.String(","),
* RowDelimiter: pulumi.String("NEW"),
* Encoding: pulumi.String("UTF-8"),
* QuoteCharacter: pulumi.String("x"),
* EscapeCharacter: pulumi.String("f"),
* FirstRowAsHeader: pulumi.Bool(true),
* NullValue: pulumi.String("NULL"),
* })
* 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.LinkedServiceWeb;
* import com.pulumi.azure.datafactory.LinkedServiceWebArgs;
* import com.pulumi.azure.datafactory.DatasetDelimitedText;
* import com.pulumi.azure.datafactory.DatasetDelimitedTextArgs;
* import com.pulumi.azure.datafactory.inputs.DatasetDelimitedTextHttpServerLocationArgs;
* 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 exampleLinkedServiceWeb = new LinkedServiceWeb("exampleLinkedServiceWeb", LinkedServiceWebArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .authenticationType("Anonymous")
* .url("https://www.bing.com")
* .build());
* var exampleDatasetDelimitedText = new DatasetDelimitedText("exampleDatasetDelimitedText", DatasetDelimitedTextArgs.builder()
* .name("example")
* .dataFactoryId(exampleFactory.id())
* .linkedServiceName(exampleLinkedServiceWeb.name())
* .httpServerLocation(DatasetDelimitedTextHttpServerLocationArgs.builder()
* .relativeUrl("http://www.bing.com")
* .path("foo/bar/")
* .filename("fizz.txt")
* .build())
* .columnDelimiter(",")
* .rowDelimiter("NEW")
* .encoding("UTF-8")
* .quoteCharacter("x")
* .escapeCharacter("f")
* .firstRowAsHeader(true)
* .nullValue("NULL")
* .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}
* exampleLinkedServiceWeb:
* type: azure:datafactory:LinkedServiceWeb
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* authenticationType: Anonymous
* url: https://www.bing.com
* exampleDatasetDelimitedText:
* type: azure:datafactory:DatasetDelimitedText
* name: example
* properties:
* name: example
* dataFactoryId: ${exampleFactory.id}
* linkedServiceName: ${exampleLinkedServiceWeb.name}
* httpServerLocation:
* relativeUrl: http://www.bing.com
* path: foo/bar/
* filename: fizz.txt
* columnDelimiter: ','
* rowDelimiter: NEW
* encoding: UTF-8
* quoteCharacter: x
* escapeCharacter: f
* firstRowAsHeader: true
* nullValue: NULL
* ```
*
* ## Import
* Data Factory Datasets can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:datafactory/datasetDelimitedText:DatasetDelimitedText example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example
* ```
*/
public class DatasetDelimitedText internal constructor(
override val javaResource: com.pulumi.azure.datafactory.DatasetDelimitedText,
) : KotlinCustomResource(javaResource, DatasetDelimitedTextMapper) {
/**
* A map of additional properties to associate with the Data Factory Dataset.
* The following supported locations for a Delimited Text Dataset (exactly one of them must be set):
*/
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 Dataset.
*/
public val annotations: Output>?
get() = javaResource.annotations().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* An `azure_blob_fs_location` block as defined below.
*/
public val azureBlobFsLocation: Output?
get() = javaResource.azureBlobFsLocation().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
datasetDelimitedTextAzureBlobFsLocationToKotlin(args0)
})
}).orElse(null)
})
/**
* An `azure_blob_storage_location` block as defined below.
*/
public val azureBlobStorageLocation: Output?
get() = javaResource.azureBlobStorageLocation().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
datasetDelimitedTextAzureBlobStorageLocationToKotlin(args0)
})
}).orElse(null)
})
/**
* The column delimiter. Defaults to `,`.
*/
public val columnDelimiter: Output?
get() = javaResource.columnDelimiter().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The compression codec used to read/write text files. Valid values are `None`, `bzip2`, `gzip`, `deflate`, `ZipDeflate`, `TarGzip`, `Tar`, `snappy` and `lz4`. Please note these values are case sensitive.
*/
public val compressionCodec: Output?
get() = javaResource.compressionCodec().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The compression ratio for the Data Factory Dataset. Valid values are `Fastest` or `Optimal`. Please note these values are case sensitive.
*/
public val compressionLevel: Output?
get() = javaResource.compressionLevel().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 Dataset.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The encoding format for the file.
*/
public val encoding: Output?
get() = javaResource.encoding().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The escape character. Defaults to `\`.
*/
public val escapeCharacter: Output?
get() = javaResource.escapeCharacter().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* When used as input, treat the first row of data as headers. When used as output, write the headers into the output as the first row of data. Defaults to `false`.
*/
public val firstRowAsHeader: Output?
get() = javaResource.firstRowAsHeader().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
*/
public val folder: Output?
get() = javaResource.folder().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A `http_server_location` block as defined below.
* The following supported arguments are specific to Delimited Text Dataset:
*/
public val httpServerLocation: Output?
get() = javaResource.httpServerLocation().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> datasetDelimitedTextHttpServerLocationToKotlin(args0) })
}).orElse(null)
})
/**
* The Data Factory Linked Service name in which to associate the Dataset with.
*/
public val linkedServiceName: Output
get() = javaResource.linkedServiceName().applyValue({ args0 -> args0 })
/**
* Specifies the name of the Data Factory Dataset. 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 })
/**
* The null value string. Defaults to `""`.
*/
public val nullValue: Output?
get() = javaResource.nullValue().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A map of parameters to associate with the Data Factory Dataset.
*/
public val parameters: Output>?
get() = javaResource.parameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The quote character. Defaults to `"`.
*/
public val quoteCharacter: Output?
get() = javaResource.quoteCharacter().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The row delimiter. Defaults to any of the following values on read: `\r\n`, `\r`, `\n`, and `\n` or `\r\n` on write by mapping data flow and Copy activity respectively.
*/
public val rowDelimiter: Output?
get() = javaResource.rowDelimiter().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A `schema_column` block as defined below.
*/
public val schemaColumns: Output>?
get() = javaResource.schemaColumns().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
datasetDelimitedTextSchemaColumnToKotlin(args0)
})
})
}).orElse(null)
})
}
public object DatasetDelimitedTextMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.datafactory.DatasetDelimitedText::class == javaResource::class
override fun map(javaResource: Resource): DatasetDelimitedText = DatasetDelimitedText(
javaResource
as com.pulumi.azure.datafactory.DatasetDelimitedText,
)
}
/**
* @see [DatasetDelimitedText].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [DatasetDelimitedText].
*/
public suspend fun datasetDelimitedText(
name: String,
block: suspend DatasetDelimitedTextResourceBuilder.() -> Unit,
): DatasetDelimitedText {
val builder = DatasetDelimitedTextResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [DatasetDelimitedText].
* @param name The _unique_ name of the resulting resource.
*/
public fun datasetDelimitedText(name: String): DatasetDelimitedText {
val builder = DatasetDelimitedTextResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy