Class AmazonS3Dataset

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

Inheritance
System.Object
DataFactoryDatasetProperties
AmazonS3Dataset
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.DataFactory.dll
Syntax
public class AmazonS3Dataset : Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.AmazonS3Dataset>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.AmazonS3Dataset>

Constructors

AmazonS3Dataset(DataFactoryLinkedServiceReference, DataFactoryElement<String>)

Initializes a new instance of AmazonS3Dataset.

Declaration
public AmazonS3Dataset (Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference linkedServiceName, Azure.Core.Expressions.DataFactory.DataFactoryElement<string> bucketName);
Parameters
Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference linkedServiceName

Linked service reference.
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String> 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 Azure.Core.Expressions.DataFactory.DataFactoryElement<string> BucketName { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

Compression

The data compression method used for the Amazon S3 object.

Declaration
public Azure.ResourceManager.DataFactory.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 DatasetAvroFormat, DatasetJsonFormat, DatasetOrcFormat, DatasetParquetFormat and DatasetTextFormat.

Declaration
public Azure.ResourceManager.DataFactory.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 Azure.Core.Expressions.DataFactory.DataFactoryElement<string> Key { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

ModifiedDatetimeEnd

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> ModifiedDatetimeEnd { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

ModifiedDatetimeStart

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> ModifiedDatetimeStart { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

Prefix

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> Prefix { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

Version

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> Version { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected override void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<AmazonS3Dataset>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.DataFactory.Models.AmazonS3Dataset IJsonModel<AmazonS3Dataset>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
AmazonS3Dataset

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<AmazonS3Dataset>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<AmazonS3Dataset>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<AmazonS3Dataset>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.DataFactory.Models.AmazonS3Dataset IPersistableModel<AmazonS3Dataset>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
AmazonS3Dataset

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<AmazonS3Dataset>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<AmazonS3Dataset>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the service.

IPersistableModel<AmazonS3Dataset>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<AmazonS3Dataset>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.