omni.client Functions#

Functions Summary:

add_user_to_group

Blocking version of :py:func:`omni.client.add_user_to_group_with_callback`

add_user_to_group_async

Asynchronous version of :py:func:`omni.client.add_user_to_group_with_callback`

copy

Blocking version of :py:func:`omni.client.copy_with_callback`

copy_async

Asynchronous version of :py:func:`omni.client.copy_with_callback`

copy_file

Blocking version of :py:func:`omni.client.copy_file_with_callback`

copy_file_async

Asynchronous version of :py:func:`omni.client.copy_file_with_callback`

copy_folder

Blocking version of :py:func:`omni.client.copy_folder_with_callback`

copy_folder_async

Asynchronous version of :py:func:`omni.client.copy_folder_with_callback`

create_checkpoint

Blocking version of :py:func:`omni.client.create_checkpoint_with_callback`

create_checkpoint_async

Asynchronous version of :py:func:`omni.client.create_checkpoint_with_callback`

create_folder

Blocking version of :py:func:`omni.client.create_folder_with_callback`

create_folder_async

Asynchronous version of :py:func:`omni.client.create_folder_with_callback`

create_group

Blocking version of :py:func:`omni.client.create_group_with_callback`

create_group_async

Asynchronous version of :py:func:`omni.client.create_group_with_callback`

create_with_hash

Blocking version of :py:func:`omni.client.create_with_hash_with_callback`

create_with_hash_async

Asynchronous version of :py:func:`omni.client.create_with_hash_with_callback`

delete

Blocking version of :py:func:`omni.client.delete_with_callback`

delete_async

Asynchronous version of :py:func:`omni.client.delete_with_callback`

delete_single

Blocking version of :py:func:`omni.client.delete_single_with_callback`

delete_single_async

Asynchronous version of :py:func:`omni.client.delete_single_with_callback`

equal_urls

Checks if two urls are equal. This function will simply compare URLs with string equality to different parts of URLs. When to compare a raw filesystem path towards an local file URL with scheme `file`, the URL will firstly be converted to a raw filesystem path, then doing comparison.

get_acls

Blocking version of :py:func:`omni.client.get_acls_with_callback`

get_acls_async

Asynchronous version of :py:func:`omni.client.get_acls_with_callback`

get_group_users

Blocking version of :py:func:`omni.client.get_group_users_with_callback`

get_group_users_async

Asynchronous version of :py:func:`omni.client.get_group_users_with_callback`

get_groups

Blocking version of :py:func:`omni.client.get_groups_with_callback`

get_groups_async

Asynchronous version of :py:func:`omni.client.get_groups_with_callback`

get_hub_version

Blocking version of :py:func:`omni.client.get_hub_version_with_callback`

get_hub_version_async

Asynchronous version of :py:func:`omni.client.get_hub_version_with_callback`

get_local_file

Blocking version of :py:func:`omni.client.get_local_file_with_callback`

get_local_file_async

Asynchronous version of :py:func:`omni.client.get_local_file_with_callback`

get_server_info

Blocking version of :py:func:`omni.client.get_server_info_with_callback`

get_server_info_async

Asynchronous version of :py:func:`omni.client.get_server_info_with_callback`

get_user_groups

Blocking version of :py:func:`omni.client.get_user_groups_with_callback`

get_user_groups_async

Asynchronous version of :py:func:`omni.client.get_user_groups_with_callback`

get_users

Blocking version of :py:func:`omni.client.get_users_with_callback`

get_users_async

Asynchronous version of :py:func:`omni.client.get_users_with_callback`

is_local_url

Checks if the url points to a raw path or with scheme `file`.

is_omni_objects_enabled

Checks if the url support omni objects enabled.

is_tagging_enabled

Checks if the url support tagging.

is_valid_url

Checks if the url format is valid.

list

Blocking version of :py:func:`omni.client.list_with_callback`

list_async

Asynchronous version of :py:func:`omni.client.list_with_callback`

list_checkpoints

Blocking version of :py:func:`omni.client.list_checkpoints_with_callback`

list_checkpoints_async

Asynchronous version of :py:func:`omni.client.list_checkpoints_with_callback`

make_absolute_url_if_possible

This function is a wrapper of omni.client.combine_urls to handle anonymous layer and convert returned URL to raw filesystem path if possible. Also, the final URL or path will be normalized.

make_file_url_if_possible

This function is a wrapper of omni.client.make_file_url to only convert path to file url when the followings satisfy:

make_relative_url_if_possible

This function is a wrapper of omni.client.make_relative_url to handle anonymous layer and convert returned URL to raw filesystem path if possible. Also, the final URL or path will be normalized.

move

Blocking version of :py:func:`omni.client.move_with_callback`

move_async

Asynchronous version of :py:func:`omni.client.move_with_callback`

move_file

Blocking version of :py:func:`omni.client.move_file_with_callback`

move_file_async

Asynchronous version of :py:func:`omni.client.move_file_with_callback`

move_folder

Blocking version of :py:func:`omni.client.move_folder_with_callback`

move_folder_async

Asynchronous version of :py:func:`omni.client.move_folder_with_callback`

obliterate

Blocking version of :py:func:`omni.client.obliterate_with_callback`

obliterate_async

Asynchronous version of :py:func:`omni.client.obliterate_with_callback`

open_cached_file

Blocking version of :py:func:`omni.client.open_cached_file_with_callback`

open_cached_file_async

Asynchronous version of :py:func:`omni.client.open_cached_file_with_callback`

read_file

Blocking version of :py:func:`omni.client.read_file_with_callback`

read_file_async

Asynchronous version of :py:func:`omni.client.read_file_with_callback`

refresh_auth_token

Blocking version of :py:func:`omni.client.refresh_auth_token_with_callback`

refresh_auth_token_async

Asynchronous version of :py:func:`omni.client.refresh_auth_token_with_callback`

remove_group

Blocking version of :py:func:`omni.client.remove_group_with_callback`

remove_group_async

Asynchronous version of :py:func:`omni.client.remove_group_with_callback`

remove_user_from_group

Blocking version of :py:func:`omni.client.remove_user_from_group_with_callback`

remove_user_from_group_async

Asynchronous version of :py:func:`omni.client.remove_user_from_group_with_callback`

rename_group

Blocking version of :py:func:`omni.client.rename_group_with_callback`

rename_group_async

Asynchronous version of :py:func:`omni.client.rename_group_with_callback`

resolve

Blocking version of :py:func:`omni.client.resolve_with_callback`

resolve_async

Asynchronous version of :py:func:`omni.client.resolve_with_callback`

send_message

Blocking version of :py:func:`omni.client.send_message_with_callback`

send_message_async

Asynchronous version of :py:func:`omni.client.send_message_with_callback`

set_acls

Blocking version of :py:func:`omni.client.set_acls_with_callback`

set_acls_async

Asynchronous version of :py:func:`omni.client.set_acls_with_callback`

set_result_if_not_done

stat

Blocking version of :py:func:`omni.client.stat_with_callback`

stat_async

Asynchronous version of :py:func:`omni.client.stat_with_callback`

undelete

Blocking version of :py:func:`omni.client.undelete_with_callback`

undelete_async

Asynchronous version of :py:func:`omni.client.undelete_with_callback`

write_file

Blocking version of :py:func:`omni.client.write_file_with_callback`

write_file_async

Asynchronous version of :py:func:`omni.client.write_file_with_callback`

write_file_ex

Blocking version of :py:func:`omni.client.write_file_ex_with_callback`

write_file_ex_async

Asynchronous version of :py:func:`omni.client.write_file_ex_with_callback`

normalize_url

normalize_url(url: str) -> str