waylay-sdk-queries-types 0.6.8.20260307

Waylay Query: timeseries queries (v1 protocol) Types

Waylay Queries Service

Execute and store queries on the Waylay timeseries.

Protocol version: v1.

This Python package is automatically generated based on the Waylay Queries OpenAPI specification (API version: 0.6.8) For more information, please visit the openapi specification.

It is considered an extension of the waylay-sdk-queries 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-queries.

Requirements.

This package requires Python 3.10+.

Installation

Normally this package is installed together with support for other services using the waylay-sdk umbrella package:

• pip install waylay-sdk will install waylay-sdk-queries together with the SDK api packages for other services.
• pip install waylay-sdk[types-queries] will additionally install the types package waylay-sdk-queries-types.
• pip install waylay-sdk[types] will install the types packages for this and all other services.

Alternatively, you can install support for this queries service only, installing or extending an existing waylay-sdk-core:

• pip install waylay-sdk-queries to only install api support for queries.
• pip install waylay-sdk-queries[types] to additionally install type support for queries.

Usage

# 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-queries-types` is installed
from waylay.services.queries.models.execute_query_queries_v1_data_post_interpolation_parameter import ExecuteQueryQueriesV1DataPostInterpolationParameter
from waylay.services.queries.models.execute_query_queries_v1_data_post_render_parameter import ExecuteQueryQueriesV1DataPostRenderParameter
from waylay.services.queries.models.query_input import QueryInput
from waylay.services.queries.models.query_result import QueryResult
try:
    # Execute Query
    # calls `POST /queries/v1/data`
    api_response = await waylay_client.queries.execute.execute(
        # query parameters:
        query = {
            'resource': '13efb488-75ac-4dac-828a-d49c5c2ebbfc',
            'metric': 'temperature',
            'interpolation': 'pad',
            'render': 'HEADER_ROW',
        },
        # json data: use a generated model or a json-serializable python data structure (dict, list)
        json = waylay.services.queries.QueryInput(), # QueryInput | 
        headers = {
            'accept': 'accept_example',
        },
    )
    print(f"Response: {api_response}")
except ApiError as e:
    print("Exception when calling queries.execute.execute: %s\n" % e)

For more information, please visit the Waylay API documentation.