AmazonS3Dataset Class

Definition

Namespace:

Azure.ResourceManager.DataFactory.Models

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.5.0

Source:

AmazonS3Dataset.cs

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

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>

type AmazonS3Dataset = class
    inherit DataFactoryDatasetProperties
    interface IJsonModel<AmazonS3Dataset>
    interface IPersistableModel<AmazonS3Dataset>

Public Class AmazonS3Dataset
Inherits DataFactoryDatasetProperties
Implements IJsonModel(Of AmazonS3Dataset), IPersistableModel(Of AmazonS3Dataset)

Inheritance

Object

DataFactoryDatasetProperties

AmazonS3Dataset

Implements

IJsonModel<AmazonS3Dataset> IPersistableModel<AmazonS3Dataset> IPersistableModel<T>

Constructors

AmazonS3Dataset(DataFactoryLinkedServiceReference, DataFactoryElement<String>)

Initializes a new instance of AmazonS3Dataset.

Properties

AdditionalProperties	Additional Properties To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }. (Inherited from DataFactoryDatasetProperties)
Annotations	List of tags that can be used for describing the Dataset. To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }. (Inherited from DataFactoryDatasetProperties)
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 DataFactoryDatasetProperties)
FolderName	The name of the folder that this Dataset is in. (Inherited from DataFactoryDatasetProperties)
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.
Key	The key of the Amazon S3 object. Type: string (or Expression with resultType string).
LinkedServiceName	Linked service reference. (Inherited from DataFactoryDatasetProperties)
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 DataFactoryDatasetProperties)
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 DataFactoryDatasetProperties)
Structure	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. (Inherited from DataFactoryDatasetProperties)
Version	The version for the S3 object. Type: string (or Expression with resultType string).

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

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.
IJsonModel<AmazonS3Dataset>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IJsonModel<DataFactoryDatasetProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from DataFactoryDatasetProperties)
IJsonModel<DataFactoryDatasetProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from DataFactoryDatasetProperties)
IPersistableModel<AmazonS3Dataset>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AmazonS3Dataset>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AmazonS3Dataset>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IPersistableModel<DataFactoryDatasetProperties>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from DataFactoryDatasetProperties)
IPersistableModel<DataFactoryDatasetProperties>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from DataFactoryDatasetProperties)
IPersistableModel<DataFactoryDatasetProperties>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from DataFactoryDatasetProperties)