pulumi-azure-kotlin/com.pulumi.azure.datafactory.kotlin/DatasetDelimitedTextArgs

DatasetDelimitedTextArgs

data class DatasetDelimitedTextArgs(val additionalProperties: Output<Map<String, String>>? = null, val annotations: Output<List<String>>? = null, val azureBlobFsLocation: Output<DatasetDelimitedTextAzureBlobFsLocationArgs>? = null, val azureBlobStorageLocation: Output<DatasetDelimitedTextAzureBlobStorageLocationArgs>? = null, val columnDelimiter: Output<String>? = null, val compressionCodec: Output<String>? = null, val compressionLevel: Output<String>? = null, val dataFactoryId: Output<String>? = null, val description: Output<String>? = null, val encoding: Output<String>? = null, val escapeCharacter: Output<String>? = null, val firstRowAsHeader: Output<Boolean>? = null, val folder: Output<String>? = null, val httpServerLocation: Output<DatasetDelimitedTextHttpServerLocationArgs>? = null, val linkedServiceName: Output<String>? = null, val name: Output<String>? = null, val nullValue: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val quoteCharacter: Output<String>? = null, val rowDelimiter: Output<String>? = null, val schemaColumns: Output<List<DatasetDelimitedTextSchemaColumnArgs>>? = null) : ConvertibleToJava<DatasetDelimitedTextArgs>

Manages an Azure Delimited Text Dataset inside an Azure Data Factory.

Example Usage

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleFactory = new Factory("exampleFactory", FactoryArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());
        var exampleLinkedServiceWeb = new LinkedServiceWeb("exampleLinkedServiceWeb", LinkedServiceWebArgs.builder()
            .dataFactoryId(exampleFactory.id())
            .authenticationType("Anonymous")
            .url("https://www.bing.com")
            .build());
        var exampleDatasetDelimitedText = new DatasetDelimitedText("exampleDatasetDelimitedText", DatasetDelimitedTextArgs.builder()
            .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());
    }
}
Content copied to clipboard

Import

Data Factory Datasets can be imported using the resource id, e.g.

$ pulumi import azure:datafactory/datasetDelimitedText:DatasetDelimitedText example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example
Content copied to clipboard

Constructors

Link copied to clipboard
fun DatasetDelimitedTextArgs(additionalProperties: Output<Map<String, String>>? = null, annotations: Output<List<String>>? = null, azureBlobFsLocation: Output<DatasetDelimitedTextAzureBlobFsLocationArgs>? = null, azureBlobStorageLocation: Output<DatasetDelimitedTextAzureBlobStorageLocationArgs>? = null, columnDelimiter: Output<String>? = null, compressionCodec: Output<String>? = null, compressionLevel: Output<String>? = null, dataFactoryId: Output<String>? = null, description: Output<String>? = null, encoding: Output<String>? = null, escapeCharacter: Output<String>? = null, firstRowAsHeader: Output<Boolean>? = null, folder: Output<String>? = null, httpServerLocation: Output<DatasetDelimitedTextHttpServerLocationArgs>? = null, linkedServiceName: Output<String>? = null, name: Output<String>? = null, nullValue: Output<String>? = null, parameters: Output<Map<String, String>>? = null, quoteCharacter: Output<String>? = null, rowDelimiter: Output<String>? = null, schemaColumns: Output<List<DatasetDelimitedTextSchemaColumnArgs>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): DatasetDelimitedTextArgs

Properties

Link copied to clipboard
val additionalProperties: Output<Map<String, String>>? = null

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):

Link copied to clipboard
val annotations: Output<List<String>>? = null

List of tags that can be used for describing the Data Factory Dataset.

Link copied to clipboard
val azureBlobFsLocation: Output<DatasetDelimitedTextAzureBlobFsLocationArgs>? = null

An azure_blob_fs_location block as defined below.

Link copied to clipboard
val azureBlobStorageLocation: Output<DatasetDelimitedTextAzureBlobStorageLocationArgs>? = null

An azure_blob_storage_location block as defined below.

Link copied to clipboard
val columnDelimiter: Output<String>? = null

The column delimiter. Defaults to ,.

Link copied to clipboard
val compressionCodec: Output<String>? = 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.

Link copied to clipboard
val compressionLevel: Output<String>? = null

The compression ratio for the Data Factory Dataset. Valid values are Fastest or Optimal. Please note these values are case sensitive.

Link copied to clipboard
val dataFactoryId: Output<String>? = null

The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.

Link copied to clipboard
val description: Output<String>? = null

The description for the Data Factory Dataset.

Link copied to clipboard
val encoding: Output<String>? = null

The encoding format for the file.

Link copied to clipboard
val escapeCharacter: Output<String>? = null

The escape character. Defaults to \.

Link copied to clipboard
val firstRowAsHeader: Output<Boolean>? = 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.

Link copied to clipboard
val folder: Output<String>? = null

The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.

Link copied to clipboard
val httpServerLocation: Output<DatasetDelimitedTextHttpServerLocationArgs>? = null

A http_server_location block as defined below. The following supported arguments are specific to Delimited Text Dataset:

Link copied to clipboard
val linkedServiceName: Output<String>? = null

The Data Factory Linked Service name in which to associate the Dataset with.

Link copied to clipboard
val name: Output<String>? = null

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 for all restrictions.

Link copied to clipboard
val nullValue: Output<String>? = null

The null value string. Defaults to an empty string. Defaults to "".

Link copied to clipboard
val parameters: Output<Map<String, String>>? = null

A map of parameters to associate with the Data Factory Dataset.

Link copied to clipboard
val quoteCharacter: Output<String>? = null

The quote character. Defaults to ".

Link copied to clipboard
val rowDelimiter: Output<String>? = 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.

Link copied to clipboard
val schemaColumns: Output<List<DatasetDelimitedTextSchemaColumnArgs>>? = null

A schema_column block as defined below.