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.0a20240415.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c478ef025141a39cd24abaeea3ac3b06d0315bba95669578f4797692b3f9b4a8 |
|
MD5 | ab258dd98f4bb78b9344e8d25ae2ef61 |
|
BLAKE2b-256 | ee622f171321877c27f4aaefbb1b1d5972d2eb5397e3ddf23d23ef14a66aa2c4 |
Hashes for waylay_sdk_resources_types-8.1.0a20240415-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 958bd39fd6af75bec89ac94e8101316da2f899195007d211e6472cc10797176d |
|
MD5 | 4133c75da22e7a8df9fa7705b241b5bb |
|
BLAKE2b-256 | d4690a97f25fcdf2b176ab3961bd2892d0cd60de5119894468789ffcfa159938 |