Waylay Storage Service

Manage storage buckets and subscriptions.

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

It consists of a plugin for the waylay-sdk-core package, and contains the Storage 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-storage-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-storage is included in:

• pip install waylay-sdk-core[storage] 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-storage and waylay-sdk-storage-types are included in:
• pip install waylay-sdk-core[storage,storage-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-storage-types` is installed
from waylay.services.storage.models.tenant_status_report import TenantStatusReport
try:
    # Status
    # calls `GET /storage/v1/status`
    api_response = await waylay_client.storage.about.status(
        # query parameters:
        query = {
            'include_buckets': True
            'include_queues': True
            'include_disk_usage': False
        },
    )
    print("The response of storage.about.status:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling storage.about.status: %s\n" % e)

For more information, please visit the Waylay API documentation.