asset

cloud.asset

An asset may be an array or a group.

Functions

Name	Description
delete	Deregister an asset and remove its objects from storage.
deregister	Deregister an asset.
info	Retrieve information about an asset.
list	List/search for stored assets.
list_public	List/search for publicly-shared assets.
list_shared_with	List an asset’s sharing policies.
register	Register stored objects as an asset.
share	Give another namespace permission to access an asset.
unshare	Remove access permissions for another namespace.
update_info	Update asset info settings.

delete

cloud.asset.delete(uri, *, recursive=False)

Deregister an asset and remove its objects from storage.

Parameters

Name	Type	Description	Default
uri	str	tiledb URI of the asset.	required
recursive	Optional[bool]	if True, contents of an asset will be recursively deleted. Default: False.	False

deregister

cloud.asset.deregister(uri, *, recursive=False)

Deregister an asset.

Parameters

Name	Type	Description	Default
uri	str	tiledb URI of the asset.	required
recursive	Optional[bool]	if True, contents of an asset will be recursively deregistered Default: False.	False

info

cloud.asset.info(uri)

Retrieve information about an asset.

Parameters

Name	Type	Description	Default
uri	str	tiledb URI of the asset.	required

Returns

Name	Type	Description
	Union[models.ArrayInfo, models.GroupInfo]	ArrayInfo or GroupInfo.

list

cloud.asset.list(
    namespace=None
    search=None
    type=None
    ownership_level=None
    depth=None
    expand=None
    page=None
    per_page=None
    order_by=None
)

List/search for stored assets.

Parameters

Name	Type	Description	Default
namespace	Optional[str]	The namespace to use, or the current user if absent.	None
search	Optional[str]	A search string to use.	None
type	Optional[_AssetType]	If provided, include only assets of the specified type (“array” or “group”).	None
ownership_level	Optional[_OwnershipLevel]	If provided, include only assets you own (“owned”), or only assets that are shared with you (“shared”).	None
depth	Optional[_Depth]	The depth to provide return information. If “root”, only root assets (i.e., arrays and groups that are not contained within another group) will be returned. If “all”, all assets that match (including those which are contained in another group) will be included.	None
expand	Optional[_CSVString]	Comma-separated string specifying additional information to include in the response. As of this writing, “metadata” is supported.	None
page	Optional[int]	Which page of results to retrieve. 1-based.	None
per_page	Optional[int]	How many results to include on each page.	None
order_by	Optional[str]	The order to return assets, by default “created_at desc”. Supported keys are “created_at”, “name”, and “asset_type”. They can be used alone or with “asc” or “desc” separated by a space (e.g. “created_at”, “asset_type asc”).	None

list_public

cloud.asset.list_public(
    search=None
    type=None
    depth=None
    page=None
    per_page=None
    order_by=None
)

List/search for publicly-shared assets.

Parameters

Name	Type	Description	Default
search	Optional[str]	A search string to use.	None
type	Optional[_AssetType]	If provided, include only assets of the specified type (“array” or “group”).	None
depth	Optional[_Depth]	The depth to provide return information. If “root”, only root assets (i.e., arrays and groups that are not contained within another group) will be returned. If “all”, all assets that match (including those which are contained in another group) will be included.	None
expand		Comma-separated string specifying additional information to include in the response. As of this writing, “metadata” is supported.	required
page	Optional[int]	Which page of results to retrieve. 1-based.	None
per_page	Optional[int]	How many results to include on each page.	None
order_by	Optional[str]	The order to return assets, by default “created_at desc”. Supported keys are “created_at”, “name”, and “asset_type”. They can be used alone or with “asc” or “desc” separated by a space (e.g. “created_at”, “asset_type asc”).	None

list_shared_with

cloud.asset.list_shared_with(uri)

List an asset’s sharing policies.

Parameters

Name	Type	Description	Default
uri	str	tiledb URI of the asset.	required

Returns

Name	Type	Description
	None	a list of ArraySharing or GroupSharing objects.

register

cloud.asset.register(
    storage_uri
    type
    *
    dest_uri=None
    name=None
    namespace=None
    credentials_name=None
    parent_uri=None
)

Register stored objects as an asset.

Parameters

Name	Type	Description	Default
storage_uri	str	S3, for example, URI of the data to be registered.	required
type	_AssetType	The type of asset, “array” or “group”.	required
namespace	Optional[str]	The user or organization to register the asset under. If unset will default to the logged-in user’s namespace.	None
name	Optional[str]	Name of asset.	None
description	str	Optional description.	required
credentials_name	Optional[str]	Optional name of access credentials to use. If omitted, the default for namespace will be used.	None
parent_uri	Optional[str]	Optional parent URI for group type assets.	None

share

cloud.asset.share(uri, namespace, permissions='read')

Give another namespace permission to access an asset.

Parameters

Name	Type	Description	Default
uri	str	tiledb URI of the asset.	required
namespace	str	the target namespace.	required
permissions	Optional[Union[str, List[str]]]	‘read’, ‘write’, or [‘read’, ‘write’].	'read'

unshare

cloud.asset.unshare(uri, namespace)

Remove access permissions for another namespace.

Parameters

Name	Type	Description	Default
uri	str	tiledb URI of the asset.	required
namespace	str	the target namespace.	required

update_info

cloud.asset.update_info(
    uri
    *
    description=None
    name=None
    tags=None
    access_credentials_name=None
)

Update asset info settings.

Parameters

Name	Type	Description	Default
uri	str	tiledb URI of the asset.	required
description	Optional[str]	Asset description, defaults to None	None
name	Optional[str]	Asset name, defaults to None	None
tags	Optional[List[str]]	Asset tags, defaults to None	None