Class AmazonS3Dataset

A single Amazon Simple Storage Service (S3) object or a set of S3 objects.

Inheritance
System.Object
Dataset
AmazonS3Dataset
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AmazonS3Dataset/AmazonS3DatasetConverter))]
public class AmazonS3Dataset : Azure.Analytics.Synapse.Artifacts.Models.Dataset

Constructors

AmazonS3Dataset(LinkedServiceReference, Object)

Initializes a new instance of AmazonS3Dataset.

Declaration
public AmazonS3Dataset (Azure.Analytics.Synapse.Artifacts.Models.LinkedServiceReference linkedServiceName, object bucketName);
Parameters
LinkedServiceReference linkedServiceName

Linked service reference.
System.Object bucketName

The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).
Exceptions
System.ArgumentNullException

linkedServiceName or bucketName is null.

Properties

BucketName

The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).

Declaration
public object BucketName { get; set; }
Property Value
System.Object

Compression

The data compression method used for the Amazon S3 object.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.DatasetCompression Compression { get; set; }
Property Value
DatasetCompression

Format

The format of files. Please note DatasetStorageFormat is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AvroFormat, JsonFormat, OrcFormat, ParquetFormat and TextFormat.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.DatasetStorageFormat Format { get; set; }
Property Value
DatasetStorageFormat

Key

The key of the Amazon S3 object. Type: string (or Expression with resultType string).

Declaration
public object Key { get; set; }
Property Value
System.Object

ModifiedDatetimeEnd

The end of S3 object's modified datetime. Type: string (or Expression with resultType string).

Declaration
public object ModifiedDatetimeEnd { get; set; }
Property Value
System.Object

ModifiedDatetimeStart

The start of S3 object's modified datetime. Type: string (or Expression with resultType string).

Declaration
public object ModifiedDatetimeStart { get; set; }
Property Value
System.Object

Prefix

The prefix filter for the S3 object name. Type: string (or Expression with resultType string).

Declaration
public object Prefix { get; set; }
Property Value
System.Object

Version

The version for the S3 object. Type: string (or Expression with resultType string).

Declaration
public object Version { get; set; }
Property Value
System.Object