Adf Amazon S 3 Dataset Element
X-Ref:
- Ast Adf Amazon S3 Dataset Node
- Ast Adf Cloud Storage Dataset Base Node
- Ast Adf Format Dataset Base Node
- Ast Adf Dataset Base Node
- Ast Adf Root Object Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Bucket | String | Specifies the name of the bucket that will supply the data. This is a required property | |
| LinkedServiceName | AstAdfAmazonS3LinkedServiceNode | Specifies a reference to the Amazon S3 linked service that will supply the data. This is a required reference to an existing definiton. | |
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| AdfFolder | String | Specifies the name of the folder within the ADF file structure that this asset resides. | |
| File | String | Specifies the target Azure blob file name. If not supplied, all blobs in the specified FolderPath will be used. | |
| FolderPath | String | Specifies the path to the folder. | |
| LogicalDisplayFolder | String | Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio. | |
| Version | String | When object versioning is enabled, specifies the version of the selected objects that should be used. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <Avro /> | AstAdfAvroFormatNode | AstAdfAvroFormatNode objects correspond directly to Azure Data Factory AvroFormat objects. This is a required property |
| <Binary /> | AstAdfBinaryFormatNode | AstAdfBinaryFormatNode objects correspond directly to Azure Data Factory Binary dataset objects. This is a required property |
| <Excel /> | AstAdfExcelFormatNode | AstAdfExcelFormatNode objects correspond directly to Azure Data Factory Excel Format dataset objects. This is a required property |
| <Json /> | AstAdfJsonFormatNode | AstAdfJsonFormatNode objects correspond directly to Azure Data Factory JsonFormat objects. This is a required property |
| <Orc /> | AstAdfOrcFormatNode | AstAdfOrcFormatNode objects correspond directly to Azure Data Factory OrcFormat objects. This is a required property |
| <DelimitedText /> | AstAdfDelimitedTextFormatNode | AstAdfDelimitedTextFormatNode objects correspond directly to Azure Data Factory DelimitedText Format dataset objects. This is a required property |
| <Parquet /> | AstAdfParquetFormatNode | AstAdfParquetFormatNode objects correspond directly to Azure Data Factory ParquetFormat objects. This is a required property |
| <Xml /> | AstAdfXmlFormatNode | AstAdfXmlFormatNode objects correspond directly to Azure Data Factory XmlFormat objects. This is a required property |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <AdfAnnotations> <AdfAnnotation /> </AdfAnnotations> | String | This is the collection of annotations that will be emitted in the json. |
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |
| <DatasetSchema> <Column /> </DatasetSchema> | AstAdfDatasetSchemaElementNode | Specifies the structure of the data that is supplied by the dataset. |
| <Parameters> <Parameter /> </Parameters> | AstAdfDatasetParameterNode | This is the collection of parameters that will be available to expressions in this Azure Data Factory dataset. |
| <Structure> <Column /> </Structure> | AstAdfDatasetStructureColumnNode | Specifies the structure of the data that is supplied by the dataset. |