Waylay Broker Types
Project description
Waylay Data Service
Data is ingested into the platform by the Waylay Broker.
This Python package is automatically generated based on the Waylay Data OpenAPI specification (API version: 2.14.0) For more information, please visit the openapi specification.
It is considered an extension of the waylay-sdk-data package, and it consists of the typed model classes for all path params, query params, body params and responses for each of the api methods in waylay-sdk-data
.
Requirements.
This package requires Python 3.9+.
Installation
Typically this package is installed when installing the waylay-sdk-core package to enable the service's functionality. When the service api methods are required, waylay-sdk-data is included in:
pip install waylay-sdk-core[data]
to installwaylay-sdk-core
along with only this service, orpip install waylay-sdk-core[services]
to installwaylay-sdk-core
along with all services. When the typed models are required, both waylay-sdk-data and waylay-sdk-data-types are included in:pip install waylay-sdk-core[data,data-types]
to installwaylay-sdk-core
along with only this service including the typed models, orpip install waylay-sdk-core[services,services-types]
to installwaylay-sdk-core
along with all services along with the typed models.
Usage
from pprint import pprint
# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError
# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()
# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-data-types` is installed
from waylay.services.data.models.version_response import VersionResponse
try:
# Get Service Status
# calls `GET /data/v1/`
api_response = await waylay_client.data.about.get(
)
print("The response of data.about.get:\n")
pprint(api_response)
except ApiError as e:
print("Exception when calling data.about.get: %s\n" % e)
For more information, please visit the Waylay API documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for waylay_sdk_data_types-2.14.0.20240423.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 010dd31333d69f84113bc033529ad6c58dc22f045d1db157e1acb524caa50c5e |
|
MD5 | 958f77ae0e621304e1de7e26606c9b16 |
|
BLAKE2b-256 | 119cfc04590b28f0440977cb0d93ff3c1ae1784ba51972f202893f406bb094dd |
Hashes for waylay_sdk_data_types-2.14.0.20240423-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 774ff8ff6b029598e31dd2d5661d886c152cb9a6ec4ec8a7730bc83de006c057 |
|
MD5 | 23ba21dfd38d5d1278acb6bc1d59eaad |
|
BLAKE2b-256 | b0e5e0ce206e590f7aa784c509757dd0a69e88f3986e0bc1b896cfdacb205c9f |