All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.pulumi.azurenative.datafactory.inputs.SqlDWSinkArgs Maven / Gradle / Ivy

    There is a newer version: 2.72.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.azurenative.datafactory.inputs.DWCopyCommandSettingsArgs;
import com.pulumi.azurenative.datafactory.inputs.PolybaseSettingsArgs;
import com.pulumi.azurenative.datafactory.inputs.SqlDWUpsertSettingsArgs;
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;


/**
 * A copy activity SQL Data Warehouse sink.
 * 
 */
public final class SqlDWSinkArgs extends com.pulumi.resources.ResourceArgs {

    public static final SqlDWSinkArgs Empty = new SqlDWSinkArgs();

    /**
     * Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="allowCopyCommand")
    private @Nullable Output allowCopyCommand;

    /**
     * @return Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> allowCopyCommand() {
        return Optional.ofNullable(this.allowCopyCommand);
    }

    /**
     * Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="allowPolyBase")
    private @Nullable Output allowPolyBase;

    /**
     * @return Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> allowPolyBase() {
        return Optional.ofNullable(this.allowPolyBase);
    }

    /**
     * Specifies Copy Command related settings when allowCopyCommand is true.
     * 
     */
    @Import(name="copyCommandSettings")
    private @Nullable Output copyCommandSettings;

    /**
     * @return Specifies Copy Command related settings when allowCopyCommand is true.
     * 
     */
    public Optional> copyCommandSettings() {
        return Optional.ofNullable(this.copyCommandSettings);
    }

    /**
     * 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);
    }

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

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

    /**
     * Specifies PolyBase-related settings when allowPolyBase is true.
     * 
     */
    @Import(name="polyBaseSettings")
    private @Nullable Output polyBaseSettings;

    /**
     * @return Specifies PolyBase-related settings when allowPolyBase is true.
     * 
     */
    public Optional> polyBaseSettings() {
        return Optional.ofNullable(this.polyBaseSettings);
    }

    /**
     * SQL pre-copy script. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="preCopyScript")
    private @Nullable Output preCopyScript;

    /**
     * @return SQL pre-copy script. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> preCopyScript() {
        return Optional.ofNullable(this.preCopyScript);
    }

    /**
     * Sink retry count. Type: integer (or Expression with resultType integer).
     * 
     */
    @Import(name="sinkRetryCount")
    private @Nullable Output sinkRetryCount;

    /**
     * @return Sink retry count. Type: integer (or Expression with resultType integer).
     * 
     */
    public Optional> sinkRetryCount() {
        return Optional.ofNullable(this.sinkRetryCount);
    }

    /**
     * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
     * 
     */
    @Import(name="sinkRetryWait")
    private @Nullable Output sinkRetryWait;

    /**
     * @return Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
     * 
     */
    public Optional> sinkRetryWait() {
        return Optional.ofNullable(this.sinkRetryWait);
    }

    /**
     * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
     * 
     */
    @Import(name="sqlWriterUseTableLock")
    private @Nullable Output sqlWriterUseTableLock;

    /**
     * @return Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional> sqlWriterUseTableLock() {
        return Optional.ofNullable(this.sqlWriterUseTableLock);
    }

    /**
     * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="tableOption")
    private @Nullable Output tableOption;

    /**
     * @return The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> tableOption() {
        return Optional.ofNullable(this.tableOption);
    }

    /**
     * Copy sink type.
     * Expected value is 'SqlDWSink'.
     * 
     */
    @Import(name="type", required=true)
    private Output type;

    /**
     * @return Copy sink type.
     * Expected value is 'SqlDWSink'.
     * 
     */
    public Output type() {
        return this.type;
    }

    /**
     * SQL DW upsert settings.
     * 
     */
    @Import(name="upsertSettings")
    private @Nullable Output upsertSettings;

    /**
     * @return SQL DW upsert settings.
     * 
     */
    public Optional> upsertSettings() {
        return Optional.ofNullable(this.upsertSettings);
    }

    /**
     * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
     * 
     */
    @Import(name="writeBatchSize")
    private @Nullable Output writeBatchSize;

    /**
     * @return Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
     * 
     */
    public Optional> writeBatchSize() {
        return Optional.ofNullable(this.writeBatchSize);
    }

    /**
     * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
     * 
     */
    @Import(name="writeBatchTimeout")
    private @Nullable Output writeBatchTimeout;

    /**
     * @return Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
     * 
     */
    public Optional> writeBatchTimeout() {
        return Optional.ofNullable(this.writeBatchTimeout);
    }

    /**
     * Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum)
     * 
     */
    @Import(name="writeBehavior")
    private @Nullable Output writeBehavior;

    /**
     * @return Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum)
     * 
     */
    public Optional> writeBehavior() {
        return Optional.ofNullable(this.writeBehavior);
    }

    private SqlDWSinkArgs() {}

    private SqlDWSinkArgs(SqlDWSinkArgs $) {
        this.allowCopyCommand = $.allowCopyCommand;
        this.allowPolyBase = $.allowPolyBase;
        this.copyCommandSettings = $.copyCommandSettings;
        this.disableMetricsCollection = $.disableMetricsCollection;
        this.maxConcurrentConnections = $.maxConcurrentConnections;
        this.polyBaseSettings = $.polyBaseSettings;
        this.preCopyScript = $.preCopyScript;
        this.sinkRetryCount = $.sinkRetryCount;
        this.sinkRetryWait = $.sinkRetryWait;
        this.sqlWriterUseTableLock = $.sqlWriterUseTableLock;
        this.tableOption = $.tableOption;
        this.type = $.type;
        this.upsertSettings = $.upsertSettings;
        this.writeBatchSize = $.writeBatchSize;
        this.writeBatchTimeout = $.writeBatchTimeout;
        this.writeBehavior = $.writeBehavior;
    }

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

    public static final class Builder {
        private SqlDWSinkArgs $;

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

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

        /**
         * @param allowCopyCommand Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder allowCopyCommand(@Nullable Output allowCopyCommand) {
            $.allowCopyCommand = allowCopyCommand;
            return this;
        }

        /**
         * @param allowCopyCommand Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder allowCopyCommand(Object allowCopyCommand) {
            return allowCopyCommand(Output.of(allowCopyCommand));
        }

        /**
         * @param allowPolyBase Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder allowPolyBase(@Nullable Output allowPolyBase) {
            $.allowPolyBase = allowPolyBase;
            return this;
        }

        /**
         * @param allowPolyBase Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder allowPolyBase(Object allowPolyBase) {
            return allowPolyBase(Output.of(allowPolyBase));
        }

        /**
         * @param copyCommandSettings Specifies Copy Command related settings when allowCopyCommand is true.
         * 
         * @return builder
         * 
         */
        public Builder copyCommandSettings(@Nullable Output copyCommandSettings) {
            $.copyCommandSettings = copyCommandSettings;
            return this;
        }

        /**
         * @param copyCommandSettings Specifies Copy Command related settings when allowCopyCommand is true.
         * 
         * @return builder
         * 
         */
        public Builder copyCommandSettings(DWCopyCommandSettingsArgs copyCommandSettings) {
            return copyCommandSettings(Output.of(copyCommandSettings));
        }

        /**
         * @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 maxConcurrentConnections The maximum concurrent connection count for the sink 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 sink data store. Type: integer (or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder maxConcurrentConnections(Object maxConcurrentConnections) {
            return maxConcurrentConnections(Output.of(maxConcurrentConnections));
        }

        /**
         * @param polyBaseSettings Specifies PolyBase-related settings when allowPolyBase is true.
         * 
         * @return builder
         * 
         */
        public Builder polyBaseSettings(@Nullable Output polyBaseSettings) {
            $.polyBaseSettings = polyBaseSettings;
            return this;
        }

        /**
         * @param polyBaseSettings Specifies PolyBase-related settings when allowPolyBase is true.
         * 
         * @return builder
         * 
         */
        public Builder polyBaseSettings(PolybaseSettingsArgs polyBaseSettings) {
            return polyBaseSettings(Output.of(polyBaseSettings));
        }

        /**
         * @param preCopyScript SQL pre-copy script. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder preCopyScript(@Nullable Output preCopyScript) {
            $.preCopyScript = preCopyScript;
            return this;
        }

        /**
         * @param preCopyScript SQL pre-copy script. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder preCopyScript(Object preCopyScript) {
            return preCopyScript(Output.of(preCopyScript));
        }

        /**
         * @param sinkRetryCount Sink retry count. Type: integer (or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder sinkRetryCount(@Nullable Output sinkRetryCount) {
            $.sinkRetryCount = sinkRetryCount;
            return this;
        }

        /**
         * @param sinkRetryCount Sink retry count. Type: integer (or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder sinkRetryCount(Object sinkRetryCount) {
            return sinkRetryCount(Output.of(sinkRetryCount));
        }

        /**
         * @param sinkRetryWait Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
         * 
         * @return builder
         * 
         */
        public Builder sinkRetryWait(@Nullable Output sinkRetryWait) {
            $.sinkRetryWait = sinkRetryWait;
            return this;
        }

        /**
         * @param sinkRetryWait Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
         * 
         * @return builder
         * 
         */
        public Builder sinkRetryWait(Object sinkRetryWait) {
            return sinkRetryWait(Output.of(sinkRetryWait));
        }

        /**
         * @param sqlWriterUseTableLock Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder sqlWriterUseTableLock(@Nullable Output sqlWriterUseTableLock) {
            $.sqlWriterUseTableLock = sqlWriterUseTableLock;
            return this;
        }

        /**
         * @param sqlWriterUseTableLock Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).
         * 
         * @return builder
         * 
         */
        public Builder sqlWriterUseTableLock(Object sqlWriterUseTableLock) {
            return sqlWriterUseTableLock(Output.of(sqlWriterUseTableLock));
        }

        /**
         * @param tableOption The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder tableOption(@Nullable Output tableOption) {
            $.tableOption = tableOption;
            return this;
        }

        /**
         * @param tableOption The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder tableOption(Object tableOption) {
            return tableOption(Output.of(tableOption));
        }

        /**
         * @param type Copy sink type.
         * Expected value is 'SqlDWSink'.
         * 
         * @return builder
         * 
         */
        public Builder type(Output type) {
            $.type = type;
            return this;
        }

        /**
         * @param type Copy sink type.
         * Expected value is 'SqlDWSink'.
         * 
         * @return builder
         * 
         */
        public Builder type(String type) {
            return type(Output.of(type));
        }

        /**
         * @param upsertSettings SQL DW upsert settings.
         * 
         * @return builder
         * 
         */
        public Builder upsertSettings(@Nullable Output upsertSettings) {
            $.upsertSettings = upsertSettings;
            return this;
        }

        /**
         * @param upsertSettings SQL DW upsert settings.
         * 
         * @return builder
         * 
         */
        public Builder upsertSettings(SqlDWUpsertSettingsArgs upsertSettings) {
            return upsertSettings(Output.of(upsertSettings));
        }

        /**
         * @param writeBatchSize Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
         * 
         * @return builder
         * 
         */
        public Builder writeBatchSize(@Nullable Output writeBatchSize) {
            $.writeBatchSize = writeBatchSize;
            return this;
        }

        /**
         * @param writeBatchSize Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
         * 
         * @return builder
         * 
         */
        public Builder writeBatchSize(Object writeBatchSize) {
            return writeBatchSize(Output.of(writeBatchSize));
        }

        /**
         * @param writeBatchTimeout Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
         * 
         * @return builder
         * 
         */
        public Builder writeBatchTimeout(@Nullable Output writeBatchTimeout) {
            $.writeBatchTimeout = writeBatchTimeout;
            return this;
        }

        /**
         * @param writeBatchTimeout Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
         * 
         * @return builder
         * 
         */
        public Builder writeBatchTimeout(Object writeBatchTimeout) {
            return writeBatchTimeout(Output.of(writeBatchTimeout));
        }

        /**
         * @param writeBehavior Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum)
         * 
         * @return builder
         * 
         */
        public Builder writeBehavior(@Nullable Output writeBehavior) {
            $.writeBehavior = writeBehavior;
            return this;
        }

        /**
         * @param writeBehavior Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum)
         * 
         * @return builder
         * 
         */
        public Builder writeBehavior(Object writeBehavior) {
            return writeBehavior(Output.of(writeBehavior));
        }

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

}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy