Share via

DatasetVersion Class

DatasetVersion Definition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FileDatasetVersion, FolderDatasetVersion

Constructor

DatasetVersion(*args: Any, **kwargs: Any)

Variables

Name Description
data_uri
str

URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330. Required.
type
str or DatasetType

Dataset type. Required. Known values are: "uri_file" and "uri_folder".
is_reference
bool

Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted.
connection_name
str

The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset.
id
str

Asset ID, a unique identifier for the asset.
name
str

The name of the resource. Required.
version
str

The version of the resource. Required.
description
str

The asset description text.
tags
dict[str, str]

Tag dictionary. Tags can be added, removed, and updated.

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear

Remove all items from D.
copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy 

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

Returns

Type Description
ItemsView

set-like object providing a view on D's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> Tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Returns

Type Description
ValuesView

an object providing a view on D's values

Attributes

connection_name

The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset.

connection_name: str | None

data_uri

https://go.microsoft.com/fwlink/?linkid=2202330. Required.

data_uri: str

description

The asset description text.

description: str | None

id

Asset ID, a unique identifier for the asset.

id: str | None

is_reference

Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted.

is_reference: bool | None

name

The name of the resource. Required.

name: str

tags

Tag dictionary. Tags can be added, removed, and updated.

tags: Dict[str, str] | None

type

"uri_file" and "uri_folder".

type: str

version

The version of the resource. Required.

version: str