Share via

AmazonS3Dataset interface

  • Reference
Package:
@azure/arm-datafactory

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

Extends
Dataset

Properties

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.
format

The format of files.
key

The key of the Amazon S3 object. Type: string (or Expression with resultType string).
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).
prefix

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

Polymorphic discriminator, which specifies the different types this object can be
version

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

Inherited Properties

annotations

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

Dataset description.
folder

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

Linked service reference.
parameters

Parameters for dataset.
schema

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

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

Property Details

bucketName

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

bucketName: any

Property Value

any

compression

The data compression method used for the Amazon S3 object.

compression?: DatasetCompression

Property Value

DatasetCompression

format

The format of files.

format?: DatasetStorageFormatUnion

Property Value

DatasetStorageFormatUnion

key

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

key?: any

Property Value

any

modifiedDatetimeEnd

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

modifiedDatetimeEnd?: any

Property Value

any

modifiedDatetimeStart

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

modifiedDatetimeStart?: any

Property Value

any

prefix

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

prefix?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "AmazonS3Object"

Property Value

"AmazonS3Object"

version

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

version?: any

Property Value

any

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From Dataset.annotations

description

Dataset description.

description?: string

Property Value

string

Inherited From Dataset.description

folder

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

folder?: DatasetFolder

Property Value

DatasetFolder

Inherited From Dataset.folder

linkedServiceName

Linked service reference.

linkedServiceName: LinkedServiceReference

Property Value

LinkedServiceReference

Inherited From Dataset.linkedServiceName

parameters

Parameters for dataset.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From Dataset.parameters

schema

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

schema?: any

Property Value

any

Inherited From Dataset.schema

structure

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

structure?: any

Property Value

any

Inherited From Dataset.structure