Skip to main content

Waylay Query: timeseries queries (v1 protocol) Types

Project description

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.5.0) 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.9+.

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

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-queries-types` is installed
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'
        },
        # 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("The response of queries.execute.execute:\n")
    pprint(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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

waylay_sdk_queries_types-0.5.0.20241025.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file waylay_sdk_queries_types-0.5.0.20241025.tar.gz.

File metadata

File hashes

Hashes for waylay_sdk_queries_types-0.5.0.20241025.tar.gz
Algorithm Hash digest
SHA256 502abc763b1df92589d58616e9fe3c52ce2e937f2d0244d73a91172708d0fea2
MD5 a33421d8749eaf6cda147b53ca038276
BLAKE2b-256 b434476fb50d78d0ad46f1514aaa3c7b915dc4877edd0eba8e73cb2cef640d7d

See more details on using hashes here.

Provenance

The following attestation bundles were made for waylay_sdk_queries_types-0.5.0.20241025.tar.gz:

Publisher: python.yml on waylayio/waylay-sdk-queries-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file waylay_sdk_queries_types-0.5.0.20241025-py3-none-any.whl.

File metadata

File hashes

Hashes for waylay_sdk_queries_types-0.5.0.20241025-py3-none-any.whl
Algorithm Hash digest
SHA256 dde79977c7f8e0e3abcb4979b9d85dca6097fe92f36be7a1597e4e05e7c8ed7d
MD5 33b96633d2f7ebbfe03ee9e6a010cf18
BLAKE2b-256 028a9f84bbaad9c8a6ac54d21282aaa7b5e3fdc63dc261f700df9ec8f0bedaa6

See more details on using hashes here.

Provenance

The following attestation bundles were made for waylay_sdk_queries_types-0.5.0.20241025-py3-none-any.whl:

Publisher: python.yml on waylayio/waylay-sdk-queries-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page