Data

Functions

wrapica.data.coerce_data_id_path_or_icav2_uri_to_data_obj(data_id_path_or_uri, create_data_if_not_found=False)

Given a data id or uri, convert to a data object

Parameters:

data_id_path_or_uri (str)
create_data_if_not_found (bool) – If true, create the data if not found (only applicable to paths or uris)

Returns:

The data object

Return type:

Data

Examples:

# Imports
from wrapica.data import coerce_data_id_or_icav2_uri_to_data_obj

# Set vars
data_id_path_or_uri = "fil.123456"  # Or icav2://project-id/path/to/file  # Or  /path/to/file

# Coerce to data object
data_obj = coerce_data_id_or_icav2_uri_to_data_obj(data_id_path_or_uri)

wrapica.data.convert_data_obj_to_icav2_uri(data_obj)

Given a data object, convert to a data uri

Parameters:: data_obj (Data)
Returns:: The data uri
Return type:: str
Examples:

# Imports
from wrapica.data import convert_data_obj_to_icav2_uri

# Set vars
data_obj = get_data_obj_from_data_id("fil.123456")

# Convert to data uri
data_uri = convert_data_obj_to_icav2_uri(data_obj)

wrapica.data.convert_icav2_uri_to_data_obj(data_uri, create_data_if_not_found=False)

Given a data uri, convert to a data object

Parameters:

data_uri (str) – The data uri
create_data_if_not_found (bool) – If true, create the data if not found

Returns:

The data object

Return type:

Data

Examples:

# Imports
from wrapica.data import convert_icav2_uri_to_data_obj

# Set vars
data_uri = "icav2://project_id/path/to/data_obj"

# Convert to data object
data_obj = convert_icav2_uri_to_data_obj(data_uri)

wrapica.data.get_data_obj_from_data_id(data_id, region_id=None)

Get data object by id

Parameters:

data_id (Union[UUID, str])
region_id (Union[UUID, str, None])

Returns:

The data object

Return type:

Data

Raises:

ApiException

Examples:

# Imports
from wrapica.data import get_data_obj_by_id

# Set vars
data_id = "fil.123456"

# Get data object by id
data_obj = get_data_obj_by_id(data_id)

wrapica.data.get_owning_project_id(data_id, region_id=None)

Get the owning project id of a data object

Parameters:

data_id (Union[UUID, str])
region_id (Union[UUID, str, None])

Returns:

The owning project id

Return type:

str

Raises:

ApiException

Examples:

# Imports
from wrapica.data import get_owning_project_id

# Set vars
data_id = "fil.123456"

# Get owning project id
owning_project_id = get_owning_project_id(data_id)

wrapica.data.get_project_data_obj_from_data_id(data_id)

Get the project data object from a data id

Parameters:: data_id (Union[UUID, str]) – The data id
Returns:: The project data object
Return type:: ProjectData
Raises:: ApiException
Examples:

# Imports
from wrapica.data import get_project_data_obj_from_data_id

# Set vars
data_id = "fil.123456"

# Get project data object from just data id
project_data_obj = get_project_data_obj_from_data_id(data_id)