Package com.azure.analytics.synapse.artifacts.models

Class AmazonS3Dataset

  • public class AmazonS3Dataset
extends Dataset
    A single Amazon Simple Storage Service (S3) object or a set of S3 objects.

    • Constructor Detail

      • AmazonS3Dataset

        public AmazonS3Dataset()

    • Method Detail

      • getBucketName

        public Object getBucketName()
        Get the bucketName property: The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
        Returns:
        the bucketName value.

      • setBucketName

        public AmazonS3Dataset setBucketName​(Object bucketName)
        Set the bucketName property: The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
        Parameters:
        bucketName - the bucketName value to set.
        Returns:
        the AmazonS3Dataset object itself.

      • getKey

        public Object getKey()
        Get the key property: The key of the Amazon S3 object. Type: string (or Expression with resultType string).
        Returns:
        the key value.

      • setKey

        public AmazonS3Dataset setKey​(Object key)
        Set the key property: The key of the Amazon S3 object. Type: string (or Expression with resultType string).
        Parameters:
        key - the key value to set.
        Returns:
        the AmazonS3Dataset object itself.

      • getPrefix

        public Object getPrefix()
        Get the prefix property: The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
        Returns:
        the prefix value.

      • setPrefix

        public AmazonS3Dataset setPrefix​(Object prefix)
        Set the prefix property: The prefix filter for the S3 object name. Type: string (or Expression with resultType string).
        Parameters:
        prefix - the prefix value to set.
        Returns:
        the AmazonS3Dataset object itself.

      • getVersion

        public Object getVersion()
        Get the version property: The version for the S3 object. Type: string (or Expression with resultType string).
        Returns:
        the version value.

      • setVersion

        public AmazonS3Dataset setVersion​(Object version)
        Set the version property: The version for the S3 object. Type: string (or Expression with resultType string).
        Parameters:
        version - the version value to set.
        Returns:
        the AmazonS3Dataset object itself.

      • getModifiedDatetimeStart

        public Object getModifiedDatetimeStart()
        Get the modifiedDatetimeStart property: The start of S3 object's modified datetime. Type: string (or Expression with resultType string).
        Returns:
        the modifiedDatetimeStart value.

      • setModifiedDatetimeStart

        public AmazonS3Dataset setModifiedDatetimeStart​(Object modifiedDatetimeStart)
        Set the modifiedDatetimeStart property: The start of S3 object's modified datetime. Type: string (or Expression with resultType string).
        Parameters:
        modifiedDatetimeStart - the modifiedDatetimeStart value to set.
        Returns:
        the AmazonS3Dataset object itself.

      • getModifiedDatetimeEnd

        public Object getModifiedDatetimeEnd()
        Get the modifiedDatetimeEnd property: The end of S3 object's modified datetime. Type: string (or Expression with resultType string).
        Returns:
        the modifiedDatetimeEnd value.

      • setModifiedDatetimeEnd

        public AmazonS3Dataset setModifiedDatetimeEnd​(Object modifiedDatetimeEnd)
        Set the modifiedDatetimeEnd property: The end of S3 object's modified datetime. Type: string (or Expression with resultType string).
        Parameters:
        modifiedDatetimeEnd - the modifiedDatetimeEnd value to set.
        Returns:
        the AmazonS3Dataset object itself.

      • getFormat

        public DatasetStorageFormat getFormat()
        Get the format property: The format of files.
        Returns:
        the format value.

      • setFormat

        public AmazonS3Dataset setFormat​(DatasetStorageFormat format)
        Set the format property: The format of files.
        Parameters:
        format - the format value to set.
        Returns:
        the AmazonS3Dataset object itself.

      • getCompression

        public DatasetCompression getCompression()
        Get the compression property: The data compression method used for the Amazon S3 object.
        Returns:
        the compression value.

      • setCompression

        public AmazonS3Dataset setCompression​(DatasetCompression compression)
        Set the compression property: The data compression method used for the Amazon S3 object.
        Parameters:
        compression - the compression value to set.
        Returns:
        the AmazonS3Dataset object itself.

      • setDescription

        public AmazonS3Dataset setDescription​(String description)
        Set the description property: Dataset description.
        Overrides:
        setDescription in class Dataset
        Parameters:
        description - the description value to set.
        Returns:
        the Dataset object itself.

      • setStructure

        public AmazonS3Dataset setStructure​(Object structure)
        Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
        Overrides:
        setStructure in class Dataset
        Parameters:
        structure - the structure value to set.
        Returns:
        the Dataset object itself.

      • setSchema

        public AmazonS3Dataset setSchema​(Object schema)
        Set the schema property: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
        Overrides:
        setSchema in class Dataset
        Parameters:
        schema - the schema value to set.
        Returns:
        the Dataset object itself.

      • setLinkedServiceName

        public AmazonS3Dataset setLinkedServiceName​(LinkedServiceReference linkedServiceName)
        Set the linkedServiceName property: Linked service reference.
        Overrides:
        setLinkedServiceName in class Dataset
        Parameters:
        linkedServiceName - the linkedServiceName value to set.
        Returns:
        the Dataset object itself.

      • setAnnotations

        public AmazonS3Dataset setAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the Dataset.
        Overrides:
        setAnnotations in class Dataset
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the Dataset object itself.

      • setFolder

        public AmazonS3Dataset setFolder​(DatasetFolder folder)
        Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
        Overrides:
        setFolder in class Dataset
        Parameters:
        folder - the folder value to set.
        Returns:
        the Dataset object itself.