BinaryDataset Class

Binary dataset.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.synapse.artifacts.models._models_py3.Dataset
BinaryDataset

Constructor

BinaryDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: typing.Union[typing.Dict[str, object], NoneType] = None, description: typing.Union[str, NoneType] = None, structure: object = None, schema: object = None, parameters: typing.Union[typing.Dict[str, _ForwardRef('ParameterSpecification')], NoneType] = None, annotations: typing.Union[typing.List[object], NoneType] = None, folder: typing.Union[_ForwardRef('DatasetFolder'), NoneType] = None, location: typing.Union[_ForwardRef('DatasetLocation'), NoneType] = None, compression: typing.Union[_ForwardRef('DatasetCompression'), NoneType] = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

Required. Type of dataset.Constant filled by server.

description
str
Required

Dataset description.

structure
object
Required

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

schema
object
Required

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

linked_service_name
LinkedServiceReference
Required

Required. Linked service reference.

parameters
dict[str, ParameterSpecification]
Required

Parameters for dataset.

annotations
list[object]
Required

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

folder
DatasetFolder
Required

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

location
DatasetLocation
Required

The location of the Binary storage.

compression
DatasetCompression
Required

The data compression method used for the binary dataset.