provenaclient

Submodules

Attributes

__version__

Classes

`ProvenaClient`	This class interface just captures that the client has an instantiated auth
`Config`
`EndpointConfig`	!!! abstract "Usage Documentation"

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(/, **data: Any)[source]

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

__class_vars__: The names of the class variables defined on the model.

__private_attributes__: Metadata about the private attributes of the model.

__signature__: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__: The core schema of the model.

__pydantic_custom_init__: Whether the model has a custom __init__ function.

__pydantic_decorators__: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__: The name of the post-init method for the model, if defined.

__pydantic_root_model__: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__: The names of fields explicitly set during instantiation.

__pydantic_private__: Values of private attributes set on the model instance.

domain: str

realm_name: str

api_overrides: APIOverrides