com.pulumi.azure.datafactory.DatasetDelimitedText Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.datafactory;
import com.pulumi.azure.Utilities;
import com.pulumi.azure.datafactory.DatasetDelimitedTextArgs;
import com.pulumi.azure.datafactory.inputs.DatasetDelimitedTextState;
import com.pulumi.azure.datafactory.outputs.DatasetDelimitedTextAzureBlobFsLocation;
import com.pulumi.azure.datafactory.outputs.DatasetDelimitedTextAzureBlobStorageLocation;
import com.pulumi.azure.datafactory.outputs.DatasetDelimitedTextHttpServerLocation;
import com.pulumi.azure.datafactory.outputs.DatasetDelimitedTextSchemaColumn;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages an Azure Delimited Text Dataset inside an Azure Data Factory.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## 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
* ```
*
*/
@ResourceType(type="azure:datafactory/datasetDelimitedText:DatasetDelimitedText")
public class DatasetDelimitedText extends com.pulumi.resources.CustomResource {
/**
* 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):
*
*/
@Export(name="additionalProperties", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> additionalProperties;
/**
* @return 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 Output>> additionalProperties() {
return Codegen.optional(this.additionalProperties);
}
/**
* List of tags that can be used for describing the Data Factory Dataset.
*
*/
@Export(name="annotations", refs={List.class,String.class}, tree="[0,1]")
private Output> annotations;
/**
* @return List of tags that can be used for describing the Data Factory Dataset.
*
*/
public Output>> annotations() {
return Codegen.optional(this.annotations);
}
/**
* An `azure_blob_fs_location` block as defined below.
*
*/
@Export(name="azureBlobFsLocation", refs={DatasetDelimitedTextAzureBlobFsLocation.class}, tree="[0]")
private Output azureBlobFsLocation;
/**
* @return An `azure_blob_fs_location` block as defined below.
*
*/
public Output> azureBlobFsLocation() {
return Codegen.optional(this.azureBlobFsLocation);
}
/**
* An `azure_blob_storage_location` block as defined below.
*
*/
@Export(name="azureBlobStorageLocation", refs={DatasetDelimitedTextAzureBlobStorageLocation.class}, tree="[0]")
private Output azureBlobStorageLocation;
/**
* @return An `azure_blob_storage_location` block as defined below.
*
*/
public Output> azureBlobStorageLocation() {
return Codegen.optional(this.azureBlobStorageLocation);
}
/**
* The column delimiter. Defaults to `,`.
*
*/
@Export(name="columnDelimiter", refs={String.class}, tree="[0]")
private Output columnDelimiter;
/**
* @return The column delimiter. Defaults to `,`.
*
*/
public Output> columnDelimiter() {
return Codegen.optional(this.columnDelimiter);
}
/**
* 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.
*
*/
@Export(name="compressionCodec", refs={String.class}, tree="[0]")
private Output compressionCodec;
/**
* @return 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 Output> compressionCodec() {
return Codegen.optional(this.compressionCodec);
}
/**
* The compression ratio for the Data Factory Dataset. Valid values are `Fastest` or `Optimal`. Please note these values are case sensitive.
*
*/
@Export(name="compressionLevel", refs={String.class}, tree="[0]")
private Output compressionLevel;
/**
* @return The compression ratio for the Data Factory Dataset. Valid values are `Fastest` or `Optimal`. Please note these values are case sensitive.
*
*/
public Output> compressionLevel() {
return Codegen.optional(this.compressionLevel);
}
/**
* The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*
*/
@Export(name="dataFactoryId", refs={String.class}, tree="[0]")
private Output dataFactoryId;
/**
* @return The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource.
*
*/
public Output dataFactoryId() {
return this.dataFactoryId;
}
/**
* The description for the Data Factory Dataset.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return The description for the Data Factory Dataset.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* The encoding format for the file.
*
*/
@Export(name="encoding", refs={String.class}, tree="[0]")
private Output encoding;
/**
* @return The encoding format for the file.
*
*/
public Output> encoding() {
return Codegen.optional(this.encoding);
}
/**
* The escape character. Defaults to `\`.
*
*/
@Export(name="escapeCharacter", refs={String.class}, tree="[0]")
private Output escapeCharacter;
/**
* @return The escape character. Defaults to `\`.
*
*/
public Output> escapeCharacter() {
return Codegen.optional(this.escapeCharacter);
}
/**
* 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`.
*
*/
@Export(name="firstRowAsHeader", refs={Boolean.class}, tree="[0]")
private Output firstRowAsHeader;
/**
* @return 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 Output> firstRowAsHeader() {
return Codegen.optional(this.firstRowAsHeader);
}
/**
* The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
*
*/
@Export(name="folder", refs={String.class}, tree="[0]")
private Output folder;
/**
* @return The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
*
*/
public Output> folder() {
return Codegen.optional(this.folder);
}
/**
* A `http_server_location` block as defined below.
*
* The following supported arguments are specific to Delimited Text Dataset:
*
*/
@Export(name="httpServerLocation", refs={DatasetDelimitedTextHttpServerLocation.class}, tree="[0]")
private Output httpServerLocation;
/**
* @return A `http_server_location` block as defined below.
*
* The following supported arguments are specific to Delimited Text Dataset:
*
*/
public Output> httpServerLocation() {
return Codegen.optional(this.httpServerLocation);
}
/**
* The Data Factory Linked Service name in which to associate the Dataset with.
*
*/
@Export(name="linkedServiceName", refs={String.class}, tree="[0]")
private Output linkedServiceName;
/**
* @return The Data Factory Linked Service name in which to associate the Dataset with.
*
*/
public Output linkedServiceName() {
return this.linkedServiceName;
}
/**
* 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.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return 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 Output name() {
return this.name;
}
/**
* The null value string. Defaults to `""`.
*
*/
@Export(name="nullValue", refs={String.class}, tree="[0]")
private Output nullValue;
/**
* @return The null value string. Defaults to `""`.
*
*/
public Output> nullValue() {
return Codegen.optional(this.nullValue);
}
/**
* A map of parameters to associate with the Data Factory Dataset.
*
*/
@Export(name="parameters", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> parameters;
/**
* @return A map of parameters to associate with the Data Factory Dataset.
*
*/
public Output>> parameters() {
return Codegen.optional(this.parameters);
}
/**
* The quote character. Defaults to `"`.
*
*/
@Export(name="quoteCharacter", refs={String.class}, tree="[0]")
private Output quoteCharacter;
/**
* @return The quote character. Defaults to `"`.
*
*/
public Output> quoteCharacter() {
return Codegen.optional(this.quoteCharacter);
}
/**
* 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.
*
*/
@Export(name="rowDelimiter", refs={String.class}, tree="[0]")
private Output rowDelimiter;
/**
* @return 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 Output> rowDelimiter() {
return Codegen.optional(this.rowDelimiter);
}
/**
* A `schema_column` block as defined below.
*
*/
@Export(name="schemaColumns", refs={List.class,DatasetDelimitedTextSchemaColumn.class}, tree="[0,1]")
private Output> schemaColumns;
/**
* @return A `schema_column` block as defined below.
*
*/
public Output>> schemaColumns() {
return Codegen.optional(this.schemaColumns);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public DatasetDelimitedText(java.lang.String name) {
this(name, DatasetDelimitedTextArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public DatasetDelimitedText(java.lang.String name, DatasetDelimitedTextArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public DatasetDelimitedText(java.lang.String name, DatasetDelimitedTextArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/datasetDelimitedText:DatasetDelimitedText", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private DatasetDelimitedText(java.lang.String name, Output id, @Nullable DatasetDelimitedTextState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:datafactory/datasetDelimitedText:DatasetDelimitedText", name, state, makeResourceOptions(options, id), false);
}
private static DatasetDelimitedTextArgs makeArgs(DatasetDelimitedTextArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? DatasetDelimitedTextArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static DatasetDelimitedText get(java.lang.String name, Output id, @Nullable DatasetDelimitedTextState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new DatasetDelimitedText(name, id, state, options);
}
}