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
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-resources is included in:
pip install waylay-sdk-core[resources]
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-resources and waylay-sdk-resources-types are included in:pip install waylay-sdk-core[resources,resources-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-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.20240415.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab7c0d6cdce2e2288a1255d6cf310eae2eb288aae180bfeb1035885c49cd73eb |
|
MD5 | 9b59be29deb8bfcf00af1ec3fefc4368 |
|
BLAKE2b-256 | 244f97c640aecab508070a35d80144dc6e54431439fa881e3612699625f11819 |
Hashes for waylay_sdk_resources_types-8.1.0.20240415-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ef77bf8ebebdf63ddb07a741dd6afaa73e81e4a683e87e60e95c12fa6378a80 |
|
MD5 | 7b2a779ab410b9b077e0494db9cce13e |
|
BLAKE2b-256 | e3a37d3738946b74b8ac408e72f1c900648490d2d5dc8606019c74837ad4e356 |