provenaclient.modules.id_service

Created Date: Friday May 31st 2024 +1000 Author: Peter Baker —– Last Modified: Friday May 31st 2024 9:50:26 am +1000 Modified By: Peter Baker —– Description: The ID Service L3 module. —– HISTORY: Date By Comments ———- — ———————————————————

Classes

IDService

This class interface just captures that the client has an instantiated auth

Module Contents

class provenaclient.modules.id_service.IDService(auth: provenaclient.modules.module_helpers.AuthManager, config: provenaclient.modules.module_helpers.Config, id_service_client: provenaclient.clients.IdServiceClient)[source]

Bases: provenaclient.modules.module_helpers.ModuleService

This class interface just captures that the client has an instantiated auth manager which allows for helper functions abstracted for L3 clients.

_id_service_client: provenaclient.clients.IdServiceClient

_auth

_config

id_service_client

async mint(body: ProvenaInterfaces.HandleAPI.MintRequest) → ProvenaInterfaces.HandleAPI.Handle[source]

Mints a new handle with given properties.

Parameters:: body (MintRequest) – The payload
Returns:: The resulting handle object
Return type:: Handle

async add_value(body: ProvenaInterfaces.HandleAPI.AddValueRequest) → ProvenaInterfaces.HandleAPI.Handle[source]

Adds value to a handle.

Parameters:: body (AddValueRequest) – The value to add
Returns:: The handle object
Return type:: Handle

async add_value_by_index(body: ProvenaInterfaces.HandleAPI.AddValueIndexRequest) → ProvenaInterfaces.HandleAPI.Handle[source]

Adds a value at specified index

Parameters:: body (AddValueIndexRequest) – The value to add
Returns:: The handle object
Return type:: Handle

async list() → ProvenaInterfaces.HandleAPI.ListResponse[source]

Lists all handles under domain.

Returns:: The response list
Return type:: ListResponse

async modify_by_index(body: ProvenaInterfaces.HandleAPI.ModifyRequest) → ProvenaInterfaces.HandleAPI.Handle[source]

Modifies existing handle value at specified index

Parameters:: body (ModifyRequest) – The request to modify
Returns:: The handle object
Return type:: Handle

async remove_by_index(body: ProvenaInterfaces.HandleAPI.RemoveRequest) → ProvenaInterfaces.HandleAPI.Handle[source]

Removes value at specified index

Parameters:: body (RemoveRequest) – The removal request
Returns:: The handle object
Return type:: Handle