Skip to content

Version

Version

Bases: Resource

Metadata about the version of the connected StreamPipes server.

ATTRIBUTE DESCRIPTION
backend_version

version of the StreamPipes backend the client is connected to

TYPE: str

Config

Configuration class for Pydantic. Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).

convert_to_pandas_representation()

Returns the dictionary representation of the version metadata to be used when creating a pandas Dataframe.

to_dict(use_source_names=True)

Returns the resource in dictionary representation.

PARAMETER DESCRIPTION
use_source_names

Indicates if the dictionary keys are in python representation or equally named to the StreamPipes backend

DEFAULT: True

RETURNS DESCRIPTION
resource

The resource as dictionary representation

TYPE: Dict[str, Any]

validate_backend_version(backend_version)

Validates the backend version of the StreamPipes. Sets 'development' if none is returned since this the behavior of StreamPipes backend running in development mode.


Last update: December 7, 2024