Waylay Resources Types
Project description
Waylay Resources Service
This service manages Waylay Resources and related entities.
A Waylay Resource models a real-world device or abstract entity of your IoT solution, and provides a context when processing data in the Rule Engine.
You'll interact with the Waylay Resources API to create this Digital Twin model, a process that's also called resource provisioning.
This Python package is automatically generated based on the Waylay Resources OpenAPI specification (API version: 8.1.0) For more information, please visit the openapi specification.
It is considered an extension of the waylay-sdk-resources 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-resources
.
Requirements.
This package requires Python 3.9+.
Installation
Normally this package is installed together with support for other services using the waylay-sdk umbrella package:
pip install waylay-sdk
will installwaylay-sdk-resources
together with the SDK api packages for other services.pip install waylay-sdk[types-resources]
will additionally install the types packagewaylay-sdk-resources-types
.pip install waylay-sdk[types]
will install the types packages for this and all other services.
Alternatively, you can install support for this resources service only, installing or extending an existing waylay-sdk-core:
pip install waylay-sdk-resources
to only install api support for resources.pip install waylay-sdk-resources[types]
to additionally install type support for resources.
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-resources-types` is installed
from waylay.services.resources.models.version_response import VersionResponse
try:
# Get Service Information
# calls `GET /resources/v1/`
api_response = await waylay_client.resources.about.get(
)
print("The response of resources.about.get:\n")
pprint(api_response)
except ApiError as e:
print("Exception when calling resources.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_resources_types-8.1.0.20240802.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7fe1313c7177e1345ec9b3078149211f5da10a05eeca6a064ec665dfc46fdcd |
|
MD5 | 039512998c561737508a420818c17f45 |
|
BLAKE2b-256 | 5571eddd18e1679e6903e2c024119e79c04256a38f734c8b22a08b4b69354135 |
Hashes for waylay_sdk_resources_types-8.1.0.20240802-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f5fafa7f4090788d40f3f2820b8c529eabdee1bb1dad44bfef8e4e53311fb73 |
|
MD5 | 67c4d9a7bd6a1f501484c006bf84f93b |
|
BLAKE2b-256 | 906031183ce336fd58b1f9e7b049c54796b9dc07afdf48bfb24e4e746e3899e5 |