Skip to main content

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)

It consists of a plugin for the waylay-sdk 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 package to enable the service's functionality. When the service api methods are required, waylay-sdk-resources is included in:

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

Usage

from pprint import pprint

# Import the waylay-client from the waylay-sdk 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 resources.models.batch_operation_enqueued import BatchOperationEnqueued
from resources.models.batch_resource_operation import BatchResourceOperation
try:
    # Bulk Delete
    # calls `POST /resources/v1/batch`
    api_response = await waylay_client.resources.batch_operations.start(
        # json data: use a generated model or a json-serializable python data structure (dict, list)
        json = resources.BatchResourceOperation() # BatchResourceOperation | Resource Batch Operation
    )
    print("The response of resources.batch_operations.start:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling resources.batch_operations.start: %s\n" % e)

Metadata

Release files for waylay-sdk-resources 8.1.0.20240328

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for waylay-sdk-resources 8.1.0.20240328
File Size Uploaded Provenance Actions
waylay-sdk-resources-8.1.0.20240328.tar.gz 16.5 kB Without provenance Details for waylay-sdk-resources-8.1.0.20240328.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for waylay-sdk-resources 8.1.0.20240328
File Interpreter ABI Platform Actions
waylay_sdk_resources-8.1.0.20240328-py3-none-any.whl Python 3 none any Details for waylay_sdk_resources-8.1.0.20240328-py3-none-any.whl

Total release size: 40.7 kB

Release files / waylay-sdk-resources-8.1.0.20240328.tar.gz

Download URL waylay-sdk-resources-8.1.0.20240328.tar.gz
Size 16.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a7d04f47e0cf72dfe743a2848524bf63a03a7d56555b34d345b06e9daa1993df
BLAKE2b-256 checksum
How to use checksums
ac9fad455482f935aedca9e3b83014ce6f6f497433407c7a7bb4b608ec8af742
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.8

Release files / waylay_sdk_resources-8.1.0.20240328-py3-none-any.whl

Download URL waylay_sdk_resources-8.1.0.20240328-py3-none-any.whl
Size 24.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8ebdf01fedeb9b203b684625549eeddf250097d047b6271dd070d95f6aefcb27
BLAKE2b-256 checksum
How to use checksums
d52cd22f36b320c81df3e71be40b37bc517a4cb913435efae59911d4eef51f8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.8

Security for waylay-sdk-resources 8.1.0.20240328

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page