provenaclient

Submodules

Attributes

__version__

Classes

`ProvenaClient`	This class interface just captures that the client has an instantiated auth
`Config`
`EndpointConfig`

Package Contents

provenaclient.__version__

class provenaclient.ProvenaClient(auth: provenaclient.modules.module_helpers.AuthManager, config: provenaclient.modules.module_helpers.Config)[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.

_datastore_client: provenaclient.clients.DatastoreClient

datastore: provenaclient.modules.Datastore

_search_client: provenaclient.clients.SearchClient

search: provenaclient.modules.Search

_auth_client: provenaclient.clients.AuthClient

auth_api: provenaclient.modules.Auth

_registry_client: provenaclient.clients.RegistryClient

registry: provenaclient.modules.Registry

_prov_client: provenaclient.clients.ProvClient

prov_api: provenaclient.modules.Prov

_job_client: provenaclient.clients.JobAPIClient

job_api: provenaclient.modules.JobService

_id_client: provenaclient.clients.IdServiceClient

id_api: provenaclient.modules.IDService

_auth

_config

class provenaclient.Config(domain: str, realm_name: str, api_overrides: APIOverrides = APIOverrides())[source]

_api_config: EndpointConfig

property search_api_endpoint: str

Generate the search api endpoint based on the provided domain, prefix and possible override value.

Returns:: A string containing the search api endpoint.
Return type:: str

property jobs_service_api_endpoint: str

Generate the job api endpoint based on the provided domain, prefix and possible override value.

Returns:: A string containing the job api endpoint.
Return type:: str

property handle_service_api_endpoint: str

Generate the handle_service api endpoint based on the provided domain, prefix and possible override value.

Returns:: A string containing the handle_service api endpoint.
Return type:: str

property search_service_endpoint: str

Generate the search_service api endpoint based on the provided domain, prefix and possible override value.

Returns:: A string containing the search_service api endpoint.
Return type:: str

property auth_api_endpoint: str

Generate the auth api endpoint based on the provided domain, prefix and possible override value.

Returns:: A string containing the auth api endpoint.
Return type:: str

property prov_api_endpoint: str

Generate the prov api endpoint based on the provided domain, prefix and possible override value.

Returns:: A string containing the prov api endpoint.
Return type:: str

property datastore_api_endpoint: str

Generate the datastore api endpoint based on the provided domain, prefix and possible override value.

Returns:: A string containing the datastore api endpoint.
Return type:: str

property registry_api_endpoint: str

Generate the registry api endpoint based on the provided domain, prefix and possible override value.

Returns:: A string containing the registry api endpoint.
Return type:: str

property keycloak_endpoint: str

Generate the keycloak realm endpoint using domain, realm_name and possible override value.

Returns:: A string containing the keycloak realm endpoint.
Return type:: str

class provenaclient.EndpointConfig[source]

Bases: pydantic.BaseModel

domain: str

realm_name: str

api_overrides: APIOverrides