Classes and methods

Reference to API classes and methods provided by the Python SDK.

Utility APIs

vianops_client.api.auth

class AuthV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

get_auth(success_codes=None)
is_authenticated()
login(username=None, password=None)
logout()
logout_memory()
logout_memory_and_config_file()

vianops_client.api.cache

class CacheV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

download(upload_key: str, local_output_path: Path)

Download a file from the stack cache.

Parameters:

  • upload_key (str) –

  • local_output_path (str, Path) – path of output file. Will be overwritten.

request_upload(filename: IO | Path) → str

Upload a file to the cache

Parameters:

filename (str, file-like object, or pathlib.Path) –

Returns:

The response json document

upload(filename: IO | Path) → str

Upload a file to the stack cache

Parameters:

filename – str, file-like object, or pathlib.Path instance

The same as request_upload() expect this function extracts and returns the upload_key instad of the json response document

Returns:

The upload_key