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

com.pulumi.azurenative.datafactory.inputs.FtpReadSettingsArgs Maven / Gradle / Ivy

There is a newer version: 2.78.0
Show newest version
// *** 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.azurenative.datafactory.inputs;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.core.internal.Codegen;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Object;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


/**
 * Ftp read settings.
 * 
 */
public final class FtpReadSettingsArgs extends com.pulumi.resources.ResourceArgs {

    public static final FtpReadSettingsArgs Empty = new FtpReadSettingsArgs();

    /**
     * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="deleteFilesAfterCompletion")
    private @Nullable Output deleteFilesAfterCompletion;

    /**
     * @return Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> deleteFilesAfterCompletion() {
        return Optional.ofNullable(this.deleteFilesAfterCompletion);
    }

    /**
     * If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="disableChunking")
    private @Nullable Output disableChunking;

    /**
     * @return If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> disableChunking() {
        return Optional.ofNullable(this.disableChunking);
    }

    /**
     * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="disableMetricsCollection")
    private @Nullable Output disableMetricsCollection;

    /**
     * @return If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> disableMetricsCollection() {
        return Optional.ofNullable(this.disableMetricsCollection);
    }

    /**
     * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="enablePartitionDiscovery")
    private @Nullable Output enablePartitionDiscovery;

    /**
     * @return Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> enablePartitionDiscovery() {
        return Optional.ofNullable(this.enablePartitionDiscovery);
    }

    /**
     * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="fileListPath")
    private @Nullable Output fileListPath;

    /**
     * @return Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> fileListPath() {
        return Optional.ofNullable(this.fileListPath);
    }

    /**
     * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
     * 
     */
    @Import(name="maxConcurrentConnections")
    private @Nullable Output maxConcurrentConnections;

    /**
     * @return The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
     * 
     */
    public Optional> maxConcurrentConnections() {
        return Optional.ofNullable(this.maxConcurrentConnections);
    }

    /**
     * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="partitionRootPath")
    private @Nullable Output partitionRootPath;

    /**
     * @return Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> partitionRootPath() {
        return Optional.ofNullable(this.partitionRootPath);
    }

    /**
     * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="recursive")
    private @Nullable Output recursive;

    /**
     * @return If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> recursive() {
        return Optional.ofNullable(this.recursive);
    }

    /**
     * The read setting type.
     * Expected value is 'FtpReadSettings'.
     * 
     */
    @Import(name="type", required=true)
    private Output type;

    /**
     * @return The read setting type.
     * Expected value is 'FtpReadSettings'.
     * 
     */
    public Output type() {
        return this.type;
    }

    /**
     * Specify whether to use binary transfer mode for FTP stores. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="useBinaryTransfer")
    private @Nullable Output useBinaryTransfer;

    /**
     * @return Specify whether to use binary transfer mode for FTP stores. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> useBinaryTransfer() {
        return Optional.ofNullable(this.useBinaryTransfer);
    }

    /**
     * Ftp wildcardFileName. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="wildcardFileName")
    private @Nullable Output wildcardFileName;

    /**
     * @return Ftp wildcardFileName. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> wildcardFileName() {
        return Optional.ofNullable(this.wildcardFileName);
    }

    /**
     * Ftp wildcardFolderPath. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="wildcardFolderPath")
    private @Nullable Output wildcardFolderPath;

    /**
     * @return Ftp wildcardFolderPath. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> wildcardFolderPath() {
        return Optional.ofNullable(this.wildcardFolderPath);
    }

    private FtpReadSettingsArgs() {}

    private FtpReadSettingsArgs(FtpReadSettingsArgs $) {
        this.deleteFilesAfterCompletion = $.deleteFilesAfterCompletion;
        this.disableChunking = $.disableChunking;
        this.disableMetricsCollection = $.disableMetricsCollection;
        this.enablePartitionDiscovery = $.enablePartitionDiscovery;
        this.fileListPath = $.fileListPath;
        this.maxConcurrentConnections = $.maxConcurrentConnections;
        this.partitionRootPath = $.partitionRootPath;
        this.recursive = $.recursive;
        this.type = $.type;
        this.useBinaryTransfer = $.useBinaryTransfer;
        this.wildcardFileName = $.wildcardFileName;
        this.wildcardFolderPath = $.wildcardFolderPath;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(FtpReadSettingsArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private FtpReadSettingsArgs $;

        public Builder() {
            $ = new FtpReadSettingsArgs();
        }

        public Builder(FtpReadSettingsArgs defaults) {
            $ = new FtpReadSettingsArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param deleteFilesAfterCompletion Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder deleteFilesAfterCompletion(@Nullable Output deleteFilesAfterCompletion) {
            $.deleteFilesAfterCompletion = deleteFilesAfterCompletion;
            return this;
        }

        /**
         * @param deleteFilesAfterCompletion Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder deleteFilesAfterCompletion(Object deleteFilesAfterCompletion) {
            return deleteFilesAfterCompletion(Output.of(deleteFilesAfterCompletion));
        }

        /**
         * @param disableChunking If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder disableChunking(@Nullable Output disableChunking) {
            $.disableChunking = disableChunking;
            return this;
        }

        /**
         * @param disableChunking If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder disableChunking(Object disableChunking) {
            return disableChunking(Output.of(disableChunking));
        }

        /**
         * @param disableMetricsCollection If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder disableMetricsCollection(@Nullable Output disableMetricsCollection) {
            $.disableMetricsCollection = disableMetricsCollection;
            return this;
        }

        /**
         * @param disableMetricsCollection If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder disableMetricsCollection(Object disableMetricsCollection) {
            return disableMetricsCollection(Output.of(disableMetricsCollection));
        }

        /**
         * @param enablePartitionDiscovery Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder enablePartitionDiscovery(@Nullable Output enablePartitionDiscovery) {
            $.enablePartitionDiscovery = enablePartitionDiscovery;
            return this;
        }

        /**
         * @param enablePartitionDiscovery Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder enablePartitionDiscovery(Object enablePartitionDiscovery) {
            return enablePartitionDiscovery(Output.of(enablePartitionDiscovery));
        }

        /**
         * @param fileListPath Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder fileListPath(@Nullable Output fileListPath) {
            $.fileListPath = fileListPath;
            return this;
        }

        /**
         * @param fileListPath Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder fileListPath(Object fileListPath) {
            return fileListPath(Output.of(fileListPath));
        }

        /**
         * @param maxConcurrentConnections The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder maxConcurrentConnections(@Nullable Output maxConcurrentConnections) {
            $.maxConcurrentConnections = maxConcurrentConnections;
            return this;
        }

        /**
         * @param maxConcurrentConnections The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder maxConcurrentConnections(Object maxConcurrentConnections) {
            return maxConcurrentConnections(Output.of(maxConcurrentConnections));
        }

        /**
         * @param partitionRootPath Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder partitionRootPath(@Nullable Output partitionRootPath) {
            $.partitionRootPath = partitionRootPath;
            return this;
        }

        /**
         * @param partitionRootPath Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder partitionRootPath(Object partitionRootPath) {
            return partitionRootPath(Output.of(partitionRootPath));
        }

        /**
         * @param recursive If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder recursive(@Nullable Output recursive) {
            $.recursive = recursive;
            return this;
        }

        /**
         * @param recursive If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder recursive(Object recursive) {
            return recursive(Output.of(recursive));
        }

        /**
         * @param type The read setting type.
         * Expected value is 'FtpReadSettings'.
         * 
         * @return builder
         * 
         */
        public Builder type(Output type) {
            $.type = type;
            return this;
        }

        /**
         * @param type The read setting type.
         * Expected value is 'FtpReadSettings'.
         * 
         * @return builder
         * 
         */
        public Builder type(String type) {
            return type(Output.of(type));
        }

        /**
         * @param useBinaryTransfer Specify whether to use binary transfer mode for FTP stores. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder useBinaryTransfer(@Nullable Output useBinaryTransfer) {
            $.useBinaryTransfer = useBinaryTransfer;
            return this;
        }

        /**
         * @param useBinaryTransfer Specify whether to use binary transfer mode for FTP stores. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder useBinaryTransfer(Object useBinaryTransfer) {
            return useBinaryTransfer(Output.of(useBinaryTransfer));
        }

        /**
         * @param wildcardFileName Ftp wildcardFileName. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder wildcardFileName(@Nullable Output wildcardFileName) {
            $.wildcardFileName = wildcardFileName;
            return this;
        }

        /**
         * @param wildcardFileName Ftp wildcardFileName. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder wildcardFileName(Object wildcardFileName) {
            return wildcardFileName(Output.of(wildcardFileName));
        }

        /**
         * @param wildcardFolderPath Ftp wildcardFolderPath. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder wildcardFolderPath(@Nullable Output wildcardFolderPath) {
            $.wildcardFolderPath = wildcardFolderPath;
            return this;
        }

        /**
         * @param wildcardFolderPath Ftp wildcardFolderPath. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder wildcardFolderPath(Object wildcardFolderPath) {
            return wildcardFolderPath(Output.of(wildcardFolderPath));
        }

        public FtpReadSettingsArgs build() {
            $.type = Codegen.stringProp("type").output().arg($.type).require();
            return $;
        }
    }

}