Share via


AmazonS3Dataset Class

Definition

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

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AmazonS3Dataset+AmazonS3DatasetConverter))]
public class AmazonS3Dataset : Azure.Analytics.Synapse.Artifacts.Models.Dataset
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AmazonS3Dataset+AmazonS3DatasetConverter))>]
type AmazonS3Dataset = class
    inherit Dataset
Public Class AmazonS3Dataset
Inherits Dataset
Inheritance
AmazonS3Dataset
Attributes

Constructors

AmazonS3Dataset(LinkedServiceReference, Object)

Initializes a new instance of AmazonS3Dataset.

Properties

AdditionalProperties

Additional Properties.

(Inherited from Dataset)
Annotations

List of tags that can be used for describing the Dataset.

(Inherited from Dataset)
BucketName

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

Compression

The data compression method used for the Amazon S3 object.

Description

Dataset description.

(Inherited from Dataset)
Folder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

(Inherited from Dataset)
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.

Key

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

LinkedServiceName

Linked service reference.

(Inherited from Dataset)
ModifiedDatetimeEnd

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

ModifiedDatetimeStart

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

Parameters

Parameters for dataset.

(Inherited from Dataset)
Prefix

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

Schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

(Inherited from Dataset)
Structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

(Inherited from Dataset)
Version

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

Applies to