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

    • com.pulumi.azurenative.datafactory.inputs.AmazonS3DatasetArgs 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.AvroFormatArgs;
import com.pulumi.azurenative.datafactory.inputs.DatasetCompressionArgs;
import com.pulumi.azurenative.datafactory.inputs.DatasetFolderArgs;
import com.pulumi.azurenative.datafactory.inputs.JsonFormatArgs;
import com.pulumi.azurenative.datafactory.inputs.LinkedServiceReferenceArgs;
import com.pulumi.azurenative.datafactory.inputs.OrcFormatArgs;
import com.pulumi.azurenative.datafactory.inputs.ParameterSpecificationArgs;
import com.pulumi.azurenative.datafactory.inputs.ParquetFormatArgs;
import com.pulumi.azurenative.datafactory.inputs.TextFormatArgs;
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.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


/**
 * A single Amazon Simple Storage Service (S3) object or a set of S3 objects.
 * 
 */
public final class AmazonS3DatasetArgs extends com.pulumi.resources.ResourceArgs {

    public static final AmazonS3DatasetArgs Empty = new AmazonS3DatasetArgs();

    /**
     * List of tags that can be used for describing the Dataset.
     * 
     */
    @Import(name="annotations")
    private @Nullable Output> annotations;

    /**
     * @return List of tags that can be used for describing the Dataset.
     * 
     */
    public Optional>> annotations() {
        return Optional.ofNullable(this.annotations);
    }

    /**
     * The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="bucketName", required=true)
    private Output bucketName;

    /**
     * @return The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
     * 
     */
    public Output bucketName() {
        return this.bucketName;
    }

    /**
     * The data compression method used for the Amazon S3 object.
     * 
     */
    @Import(name="compression")
    private @Nullable Output compression;

    /**
     * @return The data compression method used for the Amazon S3 object.
     * 
     */
    public Optional> compression() {
        return Optional.ofNullable(this.compression);
    }

    /**
     * Dataset description.
     * 
     */
    @Import(name="description")
    private @Nullable Output description;

    /**
     * @return Dataset description.
     * 
     */
    public Optional> description() {
        return Optional.ofNullable(this.description);
    }

    /**
     * The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
     * 
     */
    @Import(name="folder")
    private @Nullable Output folder;

    /**
     * @return The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
     * 
     */
    public Optional> folder() {
        return Optional.ofNullable(this.folder);
    }

    /**
     * The format of files.
     * 
     */
    @Import(name="format")
    private @Nullable Output format;

    /**
     * @return The format of files.
     * 
     */
    public Optional> format() {
        return Optional.ofNullable(this.format);
    }

    /**
     * The key of the Amazon S3 object. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="key")
    private @Nullable Output key;

    /**
     * @return The key of the Amazon S3 object. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> key() {
        return Optional.ofNullable(this.key);
    }

    /**
     * Linked service reference.
     * 
     */
    @Import(name="linkedServiceName", required=true)
    private Output linkedServiceName;

    /**
     * @return Linked service reference.
     * 
     */
    public Output linkedServiceName() {
        return this.linkedServiceName;
    }

    /**
     * The end of S3 object's modified datetime. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="modifiedDatetimeEnd")
    private @Nullable Output modifiedDatetimeEnd;

    /**
     * @return The end of S3 object's modified datetime. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> modifiedDatetimeEnd() {
        return Optional.ofNullable(this.modifiedDatetimeEnd);
    }

    /**
     * The start of S3 object's modified datetime. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="modifiedDatetimeStart")
    private @Nullable Output modifiedDatetimeStart;

    /**
     * @return The start of S3 object's modified datetime. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> modifiedDatetimeStart() {
        return Optional.ofNullable(this.modifiedDatetimeStart);
    }

    /**
     * Parameters for dataset.
     * 
     */
    @Import(name="parameters")
    private @Nullable Output> parameters;

    /**
     * @return Parameters for dataset.
     * 
     */
    public Optional>> parameters() {
        return Optional.ofNullable(this.parameters);
    }

    /**
     * The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="prefix")
    private @Nullable Output prefix;

    /**
     * @return The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> prefix() {
        return Optional.ofNullable(this.prefix);
    }

    /**
     * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
     * 
     */
    @Import(name="schema")
    private @Nullable Output schema;

    /**
     * @return Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
     * 
     */
    public Optional> schema() {
        return Optional.ofNullable(this.schema);
    }

    /**
     * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
     * 
     */
    @Import(name="structure")
    private @Nullable Output structure;

    /**
     * @return Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
     * 
     */
    public Optional> structure() {
        return Optional.ofNullable(this.structure);
    }

    /**
     * Type of dataset.
     * Expected value is 'AmazonS3Object'.
     * 
     */
    @Import(name="type", required=true)
    private Output type;

    /**
     * @return Type of dataset.
     * Expected value is 'AmazonS3Object'.
     * 
     */
    public Output type() {
        return this.type;
    }

    /**
     * The version for the S3 object. Type: string (or Expression with resultType string).
     * 
     */
    @Import(name="version")
    private @Nullable Output version;

    /**
     * @return The version for the S3 object. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> version() {
        return Optional.ofNullable(this.version);
    }

    private AmazonS3DatasetArgs() {}

    private AmazonS3DatasetArgs(AmazonS3DatasetArgs $) {
        this.annotations = $.annotations;
        this.bucketName = $.bucketName;
        this.compression = $.compression;
        this.description = $.description;
        this.folder = $.folder;
        this.format = $.format;
        this.key = $.key;
        this.linkedServiceName = $.linkedServiceName;
        this.modifiedDatetimeEnd = $.modifiedDatetimeEnd;
        this.modifiedDatetimeStart = $.modifiedDatetimeStart;
        this.parameters = $.parameters;
        this.prefix = $.prefix;
        this.schema = $.schema;
        this.structure = $.structure;
        this.type = $.type;
        this.version = $.version;
    }

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

    public static final class Builder {
        private AmazonS3DatasetArgs $;

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

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

        /**
         * @param annotations List of tags that can be used for describing the Dataset.
         * 
         * @return builder
         * 
         */
        public Builder annotations(@Nullable Output> annotations) {
            $.annotations = annotations;
            return this;
        }

        /**
         * @param annotations List of tags that can be used for describing the Dataset.
         * 
         * @return builder
         * 
         */
        public Builder annotations(List annotations) {
            return annotations(Output.of(annotations));
        }

        /**
         * @param annotations List of tags that can be used for describing the Dataset.
         * 
         * @return builder
         * 
         */
        public Builder annotations(Object... annotations) {
            return annotations(List.of(annotations));
        }

        /**
         * @param bucketName The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder bucketName(Output bucketName) {
            $.bucketName = bucketName;
            return this;
        }

        /**
         * @param bucketName The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder bucketName(Object bucketName) {
            return bucketName(Output.of(bucketName));
        }

        /**
         * @param compression The data compression method used for the Amazon S3 object.
         * 
         * @return builder
         * 
         */
        public Builder compression(@Nullable Output compression) {
            $.compression = compression;
            return this;
        }

        /**
         * @param compression The data compression method used for the Amazon S3 object.
         * 
         * @return builder
         * 
         */
        public Builder compression(DatasetCompressionArgs compression) {
            return compression(Output.of(compression));
        }

        /**
         * @param description Dataset description.
         * 
         * @return builder
         * 
         */
        public Builder description(@Nullable Output description) {
            $.description = description;
            return this;
        }

        /**
         * @param description Dataset description.
         * 
         * @return builder
         * 
         */
        public Builder description(String description) {
            return description(Output.of(description));
        }

        /**
         * @param folder The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
         * 
         * @return builder
         * 
         */
        public Builder folder(@Nullable Output folder) {
            $.folder = folder;
            return this;
        }

        /**
         * @param folder The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
         * 
         * @return builder
         * 
         */
        public Builder folder(DatasetFolderArgs folder) {
            return folder(Output.of(folder));
        }

        /**
         * @param format The format of files.
         * 
         * @return builder
         * 
         */
        public Builder format(@Nullable Output format) {
            $.format = format;
            return this;
        }

        /**
         * @param format The format of files.
         * 
         * @return builder
         * 
         */
        public Builder format(Object format) {
            return format(Output.of(format));
        }

        /**
         * @param key The key of the Amazon S3 object. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder key(@Nullable Output key) {
            $.key = key;
            return this;
        }

        /**
         * @param key The key of the Amazon S3 object. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder key(Object key) {
            return key(Output.of(key));
        }

        /**
         * @param linkedServiceName Linked service reference.
         * 
         * @return builder
         * 
         */
        public Builder linkedServiceName(Output linkedServiceName) {
            $.linkedServiceName = linkedServiceName;
            return this;
        }

        /**
         * @param linkedServiceName Linked service reference.
         * 
         * @return builder
         * 
         */
        public Builder linkedServiceName(LinkedServiceReferenceArgs linkedServiceName) {
            return linkedServiceName(Output.of(linkedServiceName));
        }

        /**
         * @param modifiedDatetimeEnd The end of S3 object's modified datetime. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder modifiedDatetimeEnd(@Nullable Output modifiedDatetimeEnd) {
            $.modifiedDatetimeEnd = modifiedDatetimeEnd;
            return this;
        }

        /**
         * @param modifiedDatetimeEnd The end of S3 object's modified datetime. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder modifiedDatetimeEnd(Object modifiedDatetimeEnd) {
            return modifiedDatetimeEnd(Output.of(modifiedDatetimeEnd));
        }

        /**
         * @param modifiedDatetimeStart The start of S3 object's modified datetime. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder modifiedDatetimeStart(@Nullable Output modifiedDatetimeStart) {
            $.modifiedDatetimeStart = modifiedDatetimeStart;
            return this;
        }

        /**
         * @param modifiedDatetimeStart The start of S3 object's modified datetime. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder modifiedDatetimeStart(Object modifiedDatetimeStart) {
            return modifiedDatetimeStart(Output.of(modifiedDatetimeStart));
        }

        /**
         * @param parameters Parameters for dataset.
         * 
         * @return builder
         * 
         */
        public Builder parameters(@Nullable Output> parameters) {
            $.parameters = parameters;
            return this;
        }

        /**
         * @param parameters Parameters for dataset.
         * 
         * @return builder
         * 
         */
        public Builder parameters(Map parameters) {
            return parameters(Output.of(parameters));
        }

        /**
         * @param prefix The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder prefix(@Nullable Output prefix) {
            $.prefix = prefix;
            return this;
        }

        /**
         * @param prefix The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder prefix(Object prefix) {
            return prefix(Output.of(prefix));
        }

        /**
         * @param schema Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
         * 
         * @return builder
         * 
         */
        public Builder schema(@Nullable Output schema) {
            $.schema = schema;
            return this;
        }

        /**
         * @param schema Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
         * 
         * @return builder
         * 
         */
        public Builder schema(Object schema) {
            return schema(Output.of(schema));
        }

        /**
         * @param structure Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
         * 
         * @return builder
         * 
         */
        public Builder structure(@Nullable Output structure) {
            $.structure = structure;
            return this;
        }

        /**
         * @param structure Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
         * 
         * @return builder
         * 
         */
        public Builder structure(Object structure) {
            return structure(Output.of(structure));
        }

        /**
         * @param type Type of dataset.
         * Expected value is 'AmazonS3Object'.
         * 
         * @return builder
         * 
         */
        public Builder type(Output type) {
            $.type = type;
            return this;
        }

        /**
         * @param type Type of dataset.
         * Expected value is 'AmazonS3Object'.
         * 
         * @return builder
         * 
         */
        public Builder type(String type) {
            return type(Output.of(type));
        }

        /**
         * @param version The version for the S3 object. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder version(@Nullable Output version) {
            $.version = version;
            return this;
        }

        /**
         * @param version The version for the S3 object. Type: string (or Expression with resultType string).
         * 
         * @return builder
         * 
         */
        public Builder version(Object version) {
            return version(Output.of(version));
        }

        public AmazonS3DatasetArgs build() {
            if ($.bucketName == null) {
                throw new MissingRequiredPropertyException("AmazonS3DatasetArgs", "bucketName");
            }
            if ($.linkedServiceName == null) {
                throw new MissingRequiredPropertyException("AmazonS3DatasetArgs", "linkedServiceName");
            }
            $.type = Codegen.stringProp("type").output().arg($.type).require();
            return $;
        }
    }

}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy