# streaming-api

Configure ThousandEyes to stream or push test data to a OpenTelemetry compliant endpoint with the ThousandEyes for OpenTelemetry API.


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 7.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git`)

Then import the package:
```python
import streaming_api
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import streaming_api
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import time
import streaming_api
from streaming_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = streaming_api.Configuration(
    host = "https://api.thousandeyes.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = streaming_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with streaming_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = streaming_api.StreamingApi(api_client)
    aid = '2067' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)
    stream = streaming_api.Stream() # Stream | Stream to configure (optional)

    try:
        # Create data stream
        api_response = api_instance.create_stream(aid=aid, stream=stream)
        print("The response of StreamingApi->create_stream:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling StreamingApi->create_stream: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.thousandeyes.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*StreamingApi* | [**create_stream**](docs/StreamingApi.md#create_stream) | **POST** /v7/stream | Create data stream
*StreamingApi* | [**delete_stream**](docs/StreamingApi.md#delete_stream) | **DELETE** /v7/stream/{id} | Delete a data stream
*StreamingApi* | [**get_stream**](docs/StreamingApi.md#get_stream) | **GET** /v7/stream/{id} | Retrieve data stream
*StreamingApi* | [**get_streams**](docs/StreamingApi.md#get_streams) | **GET** /v7/stream | List data streams
*StreamingApi* | [**put_stream**](docs/StreamingApi.md#put_stream) | **PUT** /v7/stream/{id} | Update data stream


## Documentation For Models

 - [ApiError](docs/ApiError.md)
 - [ApiErrorIntegrationLimits](docs/ApiErrorIntegrationLimits.md)
 - [AuditOperation](docs/AuditOperation.md)
 - [AuditOperationWithUpdate](docs/AuditOperationWithUpdate.md)
 - [BadRequestError](docs/BadRequestError.md)
 - [CreateStreamResponse](docs/CreateStreamResponse.md)
 - [EndpointType](docs/EndpointType.md)
 - [GetStreamResponse](docs/GetStreamResponse.md)
 - [PutStream](docs/PutStream.md)
 - [PutStreamTagMatchInner](docs/PutStreamTagMatchInner.md)
 - [Stream](docs/Stream.md)
 - [StreamResponse](docs/StreamResponse.md)
 - [StreamResponseLinks](docs/StreamResponseLinks.md)
 - [StreamResponseLinksSelf](docs/StreamResponseLinksSelf.md)
 - [StreamType](docs/StreamType.md)
 - [TagMatchObjectType](docs/TagMatchObjectType.md)
 - [UnauthorizedError](docs/UnauthorizedError.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: Bearer authentication


## Author




