waylay-sdk-resources 8.1.0.20240423

Waylay Resources

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 consists of a plugin for the waylay-sdk-core package, and contains the Resources api methods. Note that the typed model classes for all path params, query params, body params and responses for each of the api methods are contained in a separate package called waylay-sdk-resources-types.

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 install waylay-sdk-core along with only this service, or
• pip install waylay-sdk-core[services] to install waylay-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 install waylay-sdk-core along with only this service including the typed models, or
• pip install waylay-sdk-core[services,services-types] to install waylay-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.