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

com.pulumi.azurenative.datafactory.inputs.SapTableSourceArgs 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.SapTablePartitionSettingsArgs;
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 source for SAP Table source.
 * 
 */
public final class SapTableSourceArgs extends com.pulumi.resources.ResourceArgs {

    public static final SapTableSourceArgs Empty = new SapTableSourceArgs();

    /**
     * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
     * 
     */
    @Import(name="additionalColumns")
    private @Nullable Output additionalColumns;

    /**
     * @return Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
     * 
     */
    public Optional> additionalColumns() {
        return Optional.ofNullable(this.additionalColumns);
    }

    /**
     * Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).
     * 
     */
    @Import(name="batchSize")
    private @Nullable Output batchSize;

    /**
     * @return Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).
     * 
     */
    public Optional> batchSize() {
        return Optional.ofNullable(this.batchSize);
    }

    /**
     * Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="customRfcReadTableFunctionModule")
    private @Nullable Output customRfcReadTableFunctionModule;

    /**
     * @return Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> customRfcReadTableFunctionModule() {
        return Optional.ofNullable(this.customRfcReadTableFunctionModule);
    }

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

    /**
     * The partition mechanism that will be used for SAP table read in parallel. Possible values include: "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime".
     * 
     */
    @Import(name="partitionOption")
    private @Nullable Output partitionOption;

    /**
     * @return The partition mechanism that will be used for SAP table read in parallel. Possible values include: "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime".
     * 
     */
    public Optional> partitionOption() {
        return Optional.ofNullable(this.partitionOption);
    }

    /**
     * The settings that will be leveraged for SAP table source partitioning.
     * 
     */
    @Import(name="partitionSettings")
    private @Nullable Output partitionSettings;

    /**
     * @return The settings that will be leveraged for SAP table source partitioning.
     * 
     */
    public Optional> partitionSettings() {
        return Optional.ofNullable(this.partitionSettings);
    }

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

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

    /**
     * The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="rfcTableFields")
    private @Nullable Output rfcTableFields;

    /**
     * @return The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> rfcTableFields() {
        return Optional.ofNullable(this.rfcTableFields);
    }

    /**
     * The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="rfcTableOptions")
    private @Nullable Output rfcTableOptions;

    /**
     * @return The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> rfcTableOptions() {
        return Optional.ofNullable(this.rfcTableOptions);
    }

    /**
     * The number of rows to be retrieved. Type: integer(or Expression with resultType integer).
     * 
     */
    @Import(name="rowCount")
    private @Nullable Output rowCount;

    /**
     * @return The number of rows to be retrieved. Type: integer(or Expression with resultType integer).
     * 
     */
    public Optional> rowCount() {
        return Optional.ofNullable(this.rowCount);
    }

    /**
     * The number of rows that will be skipped. Type: integer (or Expression with resultType integer).
     * 
     */
    @Import(name="rowSkips")
    private @Nullable Output rowSkips;

    /**
     * @return The number of rows that will be skipped. Type: integer (or Expression with resultType integer).
     * 
     */
    public Optional> rowSkips() {
        return Optional.ofNullable(this.rowSkips);
    }

    /**
     * The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="sapDataColumnDelimiter")
    private @Nullable Output sapDataColumnDelimiter;

    /**
     * @return The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> sapDataColumnDelimiter() {
        return Optional.ofNullable(this.sapDataColumnDelimiter);
    }

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

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

    /**
     * Source 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="sourceRetryWait")
    private @Nullable Output sourceRetryWait;

    /**
     * @return Source 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> sourceRetryWait() {
        return Optional.ofNullable(this.sourceRetryWait);
    }

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

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

    private SapTableSourceArgs() {}

    private SapTableSourceArgs(SapTableSourceArgs $) {
        this.additionalColumns = $.additionalColumns;
        this.batchSize = $.batchSize;
        this.customRfcReadTableFunctionModule = $.customRfcReadTableFunctionModule;
        this.disableMetricsCollection = $.disableMetricsCollection;
        this.maxConcurrentConnections = $.maxConcurrentConnections;
        this.partitionOption = $.partitionOption;
        this.partitionSettings = $.partitionSettings;
        this.queryTimeout = $.queryTimeout;
        this.rfcTableFields = $.rfcTableFields;
        this.rfcTableOptions = $.rfcTableOptions;
        this.rowCount = $.rowCount;
        this.rowSkips = $.rowSkips;
        this.sapDataColumnDelimiter = $.sapDataColumnDelimiter;
        this.sourceRetryCount = $.sourceRetryCount;
        this.sourceRetryWait = $.sourceRetryWait;
        this.type = $.type;
    }

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

    public static final class Builder {
        private SapTableSourceArgs $;

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

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

        /**
         * @param additionalColumns Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
         * 
         * @return builder
         * 
         */
        public Builder additionalColumns(@Nullable Output additionalColumns) {
            $.additionalColumns = additionalColumns;
            return this;
        }

        /**
         * @param additionalColumns Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
         * 
         * @return builder
         * 
         */
        public Builder additionalColumns(Object additionalColumns) {
            return additionalColumns(Output.of(additionalColumns));
        }

        /**
         * @param batchSize Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder batchSize(@Nullable Output batchSize) {
            $.batchSize = batchSize;
            return this;
        }

        /**
         * @param batchSize Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder batchSize(Object batchSize) {
            return batchSize(Output.of(batchSize));
        }

        /**
         * @param customRfcReadTableFunctionModule Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder customRfcReadTableFunctionModule(@Nullable Output customRfcReadTableFunctionModule) {
            $.customRfcReadTableFunctionModule = customRfcReadTableFunctionModule;
            return this;
        }

        /**
         * @param customRfcReadTableFunctionModule Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder customRfcReadTableFunctionModule(Object customRfcReadTableFunctionModule) {
            return customRfcReadTableFunctionModule(Output.of(customRfcReadTableFunctionModule));
        }

        /**
         * @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 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 partitionOption The partition mechanism that will be used for SAP table read in parallel. Possible values include: "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime".
         * 
         * @return builder
         * 
         */
        public Builder partitionOption(@Nullable Output partitionOption) {
            $.partitionOption = partitionOption;
            return this;
        }

        /**
         * @param partitionOption The partition mechanism that will be used for SAP table read in parallel. Possible values include: "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime".
         * 
         * @return builder
         * 
         */
        public Builder partitionOption(Object partitionOption) {
            return partitionOption(Output.of(partitionOption));
        }

        /**
         * @param partitionSettings The settings that will be leveraged for SAP table source partitioning.
         * 
         * @return builder
         * 
         */
        public Builder partitionSettings(@Nullable Output partitionSettings) {
            $.partitionSettings = partitionSettings;
            return this;
        }

        /**
         * @param partitionSettings The settings that will be leveraged for SAP table source partitioning.
         * 
         * @return builder
         * 
         */
        public Builder partitionSettings(SapTablePartitionSettingsArgs partitionSettings) {
            return partitionSettings(Output.of(partitionSettings));
        }

        /**
         * @param queryTimeout Query 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 queryTimeout(@Nullable Output queryTimeout) {
            $.queryTimeout = queryTimeout;
            return this;
        }

        /**
         * @param queryTimeout Query 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 queryTimeout(Object queryTimeout) {
            return queryTimeout(Output.of(queryTimeout));
        }

        /**
         * @param rfcTableFields The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder rfcTableFields(@Nullable Output rfcTableFields) {
            $.rfcTableFields = rfcTableFields;
            return this;
        }

        /**
         * @param rfcTableFields The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder rfcTableFields(Object rfcTableFields) {
            return rfcTableFields(Output.of(rfcTableFields));
        }

        /**
         * @param rfcTableOptions The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder rfcTableOptions(@Nullable Output rfcTableOptions) {
            $.rfcTableOptions = rfcTableOptions;
            return this;
        }

        /**
         * @param rfcTableOptions The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder rfcTableOptions(Object rfcTableOptions) {
            return rfcTableOptions(Output.of(rfcTableOptions));
        }

        /**
         * @param rowCount The number of rows to be retrieved. Type: integer(or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder rowCount(@Nullable Output rowCount) {
            $.rowCount = rowCount;
            return this;
        }

        /**
         * @param rowCount The number of rows to be retrieved. Type: integer(or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder rowCount(Object rowCount) {
            return rowCount(Output.of(rowCount));
        }

        /**
         * @param rowSkips The number of rows that will be skipped. Type: integer (or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder rowSkips(@Nullable Output rowSkips) {
            $.rowSkips = rowSkips;
            return this;
        }

        /**
         * @param rowSkips The number of rows that will be skipped. Type: integer (or Expression with resultType integer).
         * 
         * @return builder
         * 
         */
        public Builder rowSkips(Object rowSkips) {
            return rowSkips(Output.of(rowSkips));
        }

        /**
         * @param sapDataColumnDelimiter The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder sapDataColumnDelimiter(@Nullable Output sapDataColumnDelimiter) {
            $.sapDataColumnDelimiter = sapDataColumnDelimiter;
            return this;
        }

        /**
         * @param sapDataColumnDelimiter The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder sapDataColumnDelimiter(Object sapDataColumnDelimiter) {
            return sapDataColumnDelimiter(Output.of(sapDataColumnDelimiter));
        }

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

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

        /**
         * @param sourceRetryWait Source 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 sourceRetryWait(@Nullable Output sourceRetryWait) {
            $.sourceRetryWait = sourceRetryWait;
            return this;
        }

        /**
         * @param sourceRetryWait Source 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 sourceRetryWait(Object sourceRetryWait) {
            return sourceRetryWait(Output.of(sourceRetryWait));
        }

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

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

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

}