mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-05 23:45:30 +00:00
[GitHub Bot] Generated python SDK
This commit is contained in:
API Team
parent
cafc4e63c7
commit
6f229435da
@ -12,7 +12,7 @@ This API provides the following operations to manage your organization:
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ Manage all agents available to your account in ThousandEyes, including both Clou
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ For more information about the alerts, see [Alerts](https://docs.thousandeyes.co
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ For more information about monitors, see [Inside-Out BGP Visibility](https://doc
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ For more information about credentials, see [Working With Secure Credentials](ht
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ Manage ThousandEyes Dashboards.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ To access Emulation API operations, the following permissions are required:
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ For more information about Endpoint Agents, see [Endpoint Agents](https://docs.t
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ The URLs for these API test data endpoints are provided within the test definiti
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ Manage labels applied to endpoint agents using this API.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ Retrieve results for scheduled and dynamic tests on endpoint agents.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -380,11 +380,11 @@ class TestRealUserEndpointTestResultsApi(unittest.TestCase):
|
||||
"log" : {
|
||||
"browser" : {
|
||||
"name" : "Google Chrome",
|
||||
"version" : "7.0.25.98"
|
||||
"version" : "7.0.26.98"
|
||||
},
|
||||
"creator" : {
|
||||
"name" : "ThousandEyes Endpoint Agent",
|
||||
"version" : "7.0.25"
|
||||
"version" : "7.0.26"
|
||||
},
|
||||
"entries" : [ {
|
||||
"pageref" : "page_1",
|
||||
|
||||
@ -5,7 +5,7 @@ Manage endpoint agent dynamic and scheduled tests using the Endpoint Tests API.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ With the Events API, you can perform the following tasks on the ThousandEyes pla
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ The response does not include the immediate test results. Use the Test Results e
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ For more information about Internet Insights, see the [Internet Insights](https:
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ Creates a new test snapshot in ThousandEyes.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ Method | HTTP request | Description
|
||||
|
||||
Create test snapshot
|
||||
|
||||
This operation creates a test snapshot based on the properties provided in the POST data. * To use this endpoint, you need the `Create snapshot shares` permission. * You can create a maximum of 5 snapshots per organization within a 5-minute interval. * Snapshots generated through this operation have a 30-day expiration period. * The time range specified with the `from` and `to` parameters must adhere to one of the following intervals: 1, 2, 4, 6, 12, 24, or 48 hours. * The `endDate` field of the snapshot must be set to the present or a past date. **Note**: This operation does not support the creation of operation Agent snapshots.
|
||||
This operation creates a test snapshot based on the properties provided in the POST data. * To use this endpoint, you need the `Create snapshot shares` permission. * You can create a maximum of 5 snapshots per organization within a 5-minute interval. * Snapshots generated through this operation have a 30-day expiration period. * The time range specified with the `from` and `to` parameters must adhere to one of the following intervals: 1, 2, 4, 6, 12, 24, or 48 hours. * The `endDate` field of the snapshot must be set to the present or a past date. * Certain regions may not have public snapshots enabled for compliance reasons. In that case you will get a 403 Forbidden as a response. **Note**: This operation does not support the creation of operation Agent snapshots.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@ -64,7 +64,7 @@ class TestSnapshotsApi:
|
||||
) -> SnapshotResponse:
|
||||
"""Create test snapshot
|
||||
|
||||
This operation creates a test snapshot based on the properties provided in the POST data. * To use this endpoint, you need the `Create snapshot shares` permission. * You can create a maximum of 5 snapshots per organization within a 5-minute interval. * Snapshots generated through this operation have a 30-day expiration period. * The time range specified with the `from` and `to` parameters must adhere to one of the following intervals: 1, 2, 4, 6, 12, 24, or 48 hours. * The `endDate` field of the snapshot must be set to the present or a past date. **Note**: This operation does not support the creation of operation Agent snapshots.
|
||||
This operation creates a test snapshot based on the properties provided in the POST data. * To use this endpoint, you need the `Create snapshot shares` permission. * You can create a maximum of 5 snapshots per organization within a 5-minute interval. * Snapshots generated through this operation have a 30-day expiration period. * The time range specified with the `from` and `to` parameters must adhere to one of the following intervals: 1, 2, 4, 6, 12, 24, or 48 hours. * The `endDate` field of the snapshot must be set to the present or a past date. * Certain regions may not have public snapshots enabled for compliance reasons. In that case you will get a 403 Forbidden as a response. **Note**: This operation does not support the creation of operation Agent snapshots.
|
||||
|
||||
:param test_id: Test ID (required)
|
||||
:type test_id: str
|
||||
@ -147,7 +147,7 @@ class TestSnapshotsApi:
|
||||
) -> ApiResponse[SnapshotResponse]:
|
||||
"""Create test snapshot
|
||||
|
||||
This operation creates a test snapshot based on the properties provided in the POST data. * To use this endpoint, you need the `Create snapshot shares` permission. * You can create a maximum of 5 snapshots per organization within a 5-minute interval. * Snapshots generated through this operation have a 30-day expiration period. * The time range specified with the `from` and `to` parameters must adhere to one of the following intervals: 1, 2, 4, 6, 12, 24, or 48 hours. * The `endDate` field of the snapshot must be set to the present or a past date. **Note**: This operation does not support the creation of operation Agent snapshots.
|
||||
This operation creates a test snapshot based on the properties provided in the POST data. * To use this endpoint, you need the `Create snapshot shares` permission. * You can create a maximum of 5 snapshots per organization within a 5-minute interval. * Snapshots generated through this operation have a 30-day expiration period. * The time range specified with the `from` and `to` parameters must adhere to one of the following intervals: 1, 2, 4, 6, 12, 24, or 48 hours. * The `endDate` field of the snapshot must be set to the present or a past date. * Certain regions may not have public snapshots enabled for compliance reasons. In that case you will get a 403 Forbidden as a response. **Note**: This operation does not support the creation of operation Agent snapshots.
|
||||
|
||||
:param test_id: Test ID (required)
|
||||
:type test_id: str
|
||||
@ -230,7 +230,7 @@ class TestSnapshotsApi:
|
||||
) -> RESTResponseType:
|
||||
"""Create test snapshot
|
||||
|
||||
This operation creates a test snapshot based on the properties provided in the POST data. * To use this endpoint, you need the `Create snapshot shares` permission. * You can create a maximum of 5 snapshots per organization within a 5-minute interval. * Snapshots generated through this operation have a 30-day expiration period. * The time range specified with the `from` and `to` parameters must adhere to one of the following intervals: 1, 2, 4, 6, 12, 24, or 48 hours. * The `endDate` field of the snapshot must be set to the present or a past date. **Note**: This operation does not support the creation of operation Agent snapshots.
|
||||
This operation creates a test snapshot based on the properties provided in the POST data. * To use this endpoint, you need the `Create snapshot shares` permission. * You can create a maximum of 5 snapshots per organization within a 5-minute interval. * Snapshots generated through this operation have a 30-day expiration period. * The time range specified with the `from` and `to` parameters must adhere to one of the following intervals: 1, 2, 4, 6, 12, 24, or 48 hours. * The `endDate` field of the snapshot must be set to the present or a past date. * Certain regions may not have public snapshots enabled for compliance reasons. In that case you will get a 403 Forbidden as a response. **Note**: This operation does not support the creation of operation Agent snapshots.
|
||||
|
||||
:param test_id: Test ID (required)
|
||||
:type test_id: str
|
||||
|
||||
@ -15,6 +15,7 @@ docs/Filters.md
|
||||
docs/FiltersTestTypes.md
|
||||
docs/GetStreamResponse.md
|
||||
docs/PutStream.md
|
||||
docs/Signal.md
|
||||
docs/Stream.md
|
||||
docs/StreamLinks.md
|
||||
docs/StreamResponse.md
|
||||
@ -47,6 +48,7 @@ src/thousandeyes_sdk/streaming/models/filters.py
|
||||
src/thousandeyes_sdk/streaming/models/filters_test_types.py
|
||||
src/thousandeyes_sdk/streaming/models/get_stream_response.py
|
||||
src/thousandeyes_sdk/streaming/models/put_stream.py
|
||||
src/thousandeyes_sdk/streaming/models/signal.py
|
||||
src/thousandeyes_sdk/streaming/models/stream.py
|
||||
src/thousandeyes_sdk/streaming/models/stream_links.py
|
||||
src/thousandeyes_sdk/streaming/models/stream_response.py
|
||||
|
||||
@ -15,7 +15,7 @@ For more information about ThousandEyes for OpenTelemetry, see the [documentatio
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
|
||||
- [FiltersTestTypes](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/FiltersTestTypes.md)
|
||||
- [GetStreamResponse](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/GetStreamResponse.md)
|
||||
- [PutStream](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/PutStream.md)
|
||||
- [Signal](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/Signal.md)
|
||||
- [Stream](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/Stream.md)
|
||||
- [StreamLinks](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/StreamLinks.md)
|
||||
- [StreamResponse](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-streaming/docs/StreamResponse.md)
|
||||
|
||||
@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
||||
**enabled** | **bool** | Flag to enable or disable the stream integration. | [optional]
|
||||
**links** | [**StreamLinks**](StreamLinks.md) | | [optional]
|
||||
**type** | [**StreamType**](StreamType.md) | | [optional]
|
||||
**signal** | [**Signal**](Signal.md) | | [optional]
|
||||
**endpoint_type** | [**EndpointType**](EndpointType.md) | | [optional]
|
||||
**stream_endpoint_url** | **str** | The URL ThousandEyes sends data stream to. For a URL to be valid, it needs to: - Be syntactically correct. - Be reachable. - Use the HTTPS protocol. - When using the `grpc` endpointType, streamEndpointUrl cannot contain paths: - Valid . `grpc` - `https://example.com` - Invalid . `grpc` - `https://example.com/collector`. - Valid . `http` - `https://example.com/collector`. - When using the `http` endpointType, the operation must match the exact final full URL (including the path if there is one) to which the metrics will be sent. Examples below: - `https://api.honeycomb.io:443/v1/metrics` - `https://ingest.eu0.signalfx.com/v2/datapoint/otlp` | [optional]
|
||||
**data_model_version** | [**DataModelVersion**](DataModelVersion.md) | | [optional]
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# DataModelVersion
|
||||
|
||||
The version of the data model used in the data stream. Default: `v2`
|
||||
The version of the data model used in the data stream. When using `v1`: - The `signal` cannot be `trace`. Default: `v2`
|
||||
|
||||
## Properties
|
||||
|
||||
|
||||
@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
||||
**enabled** | **bool** | Flag to enable or disable the stream integration. | [optional]
|
||||
**links** | [**StreamLinks**](StreamLinks.md) | | [optional]
|
||||
**type** | [**StreamType**](StreamType.md) | | [optional]
|
||||
**signal** | [**Signal**](Signal.md) | | [optional]
|
||||
**endpoint_type** | [**EndpointType**](EndpointType.md) | | [optional]
|
||||
**stream_endpoint_url** | **str** | The URL ThousandEyes sends data stream to. For a URL to be valid, it needs to: - Be syntactically correct. - Be reachable. - Use the HTTPS protocol. - When using the `grpc` endpointType, streamEndpointUrl cannot contain paths: - Valid . `grpc` - `https://example.com` - Invalid . `grpc` - `https://example.com/collector`. - Valid . `http` - `https://example.com/collector`. - When using the `http` endpointType, the operation must match the exact final full URL (including the path if there is one) to which the metrics will be sent. Examples below: - `https://api.honeycomb.io:443/v1/metrics` - `https://ingest.eu0.signalfx.com/v2/datapoint/otlp` | [optional]
|
||||
**data_model_version** | [**DataModelVersion**](DataModelVersion.md) | | [optional]
|
||||
|
||||
12
thousandeyes-sdk-streaming/docs/Signal.md
Normal file
12
thousandeyes-sdk-streaming/docs/Signal.md
Normal file
@ -0,0 +1,12 @@
|
||||
# Signal
|
||||
|
||||
The OpenTelemetry signal of the stream integration. When using `trace`: - `dataModelVersion` must be `v2`. Default: `metric`
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
||||
**filters** | [**Filters**](Filters.md) | | [optional]
|
||||
**exporter_config** | [**ExporterConfig**](ExporterConfig.md) | | [optional]
|
||||
**type** | [**StreamType**](StreamType.md) | | [optional]
|
||||
**signal** | [**Signal**](Signal.md) | | [optional]
|
||||
**endpoint_type** | [**EndpointType**](EndpointType.md) | | [optional]
|
||||
**stream_endpoint_url** | **str** | The URL ThousandEyes sends data stream to. For a URL to be valid, it needs to: - Be syntactically correct. - Be reachable. - Use the HTTPS protocol. - When using the `grpc` endpointType, streamEndpointUrl cannot contain paths: - Valid . `grpc` - `https://example.com` - Invalid . `grpc` - `https://example.com/collector`. - Valid . `http` - `https://example.com/collector`. - When using the `http` endpointType, the operation must match the exact final full URL (including the path if there is one) to which the metrics will be sent. Examples below: - `https://api.honeycomb.io:443/v1/metrics` - `https://ingest.eu0.signalfx.com/v2/datapoint/otlp` | [optional]
|
||||
**data_model_version** | [**DataModelVersion**](DataModelVersion.md) | | [optional]
|
||||
|
||||
@ -32,6 +32,7 @@ from thousandeyes_sdk.streaming.models.filters import Filters
|
||||
from thousandeyes_sdk.streaming.models.filters_test_types import FiltersTestTypes
|
||||
from thousandeyes_sdk.streaming.models.get_stream_response import GetStreamResponse
|
||||
from thousandeyes_sdk.streaming.models.put_stream import PutStream
|
||||
from thousandeyes_sdk.streaming.models.signal import Signal
|
||||
from thousandeyes_sdk.streaming.models.stream import Stream
|
||||
from thousandeyes_sdk.streaming.models.stream_links import StreamLinks
|
||||
from thousandeyes_sdk.streaming.models.stream_response import StreamResponse
|
||||
|
||||
@ -27,6 +27,7 @@ from thousandeyes_sdk.streaming.models.filters import Filters
|
||||
from thousandeyes_sdk.streaming.models.filters_test_types import FiltersTestTypes
|
||||
from thousandeyes_sdk.streaming.models.get_stream_response import GetStreamResponse
|
||||
from thousandeyes_sdk.streaming.models.put_stream import PutStream
|
||||
from thousandeyes_sdk.streaming.models.signal import Signal
|
||||
from thousandeyes_sdk.streaming.models.stream import Stream
|
||||
from thousandeyes_sdk.streaming.models.stream_links import StreamLinks
|
||||
from thousandeyes_sdk.streaming.models.stream_response import StreamResponse
|
||||
|
||||
@ -23,6 +23,7 @@ from thousandeyes_sdk.streaming.models.data_model_version import DataModelVersio
|
||||
from thousandeyes_sdk.streaming.models.endpoint_type import EndpointType
|
||||
from thousandeyes_sdk.streaming.models.exporter_config import ExporterConfig
|
||||
from thousandeyes_sdk.streaming.models.filters import Filters
|
||||
from thousandeyes_sdk.streaming.models.signal import Signal
|
||||
from thousandeyes_sdk.streaming.models.stream_links import StreamLinks
|
||||
from thousandeyes_sdk.streaming.models.stream_type import StreamType
|
||||
from thousandeyes_sdk.streaming.models.tag_match import TagMatch
|
||||
@ -38,6 +39,7 @@ class CreateStreamResponse(BaseModel):
|
||||
enabled: Optional[StrictBool] = Field(default=None, description="Flag to enable or disable the stream integration.")
|
||||
links: Optional[StreamLinks] = Field(default=None, alias="_links")
|
||||
type: Optional[StreamType] = None
|
||||
signal: Optional[Signal] = None
|
||||
endpoint_type: Optional[EndpointType] = Field(default=None, alias="endpointType")
|
||||
stream_endpoint_url: Optional[StrictStr] = Field(default=None, description="The URL ThousandEyes sends data stream to. For a URL to be valid, it needs to: - Be syntactically correct. - Be reachable. - Use the HTTPS protocol. - When using the `grpc` endpointType, streamEndpointUrl cannot contain paths: - Valid . `grpc` - `https://example.com` - Invalid . `grpc` - `https://example.com/collector`. - Valid . `http` - `https://example.com/collector`. - When using the `http` endpointType, the operation must match the exact final full URL (including the path if there is one) to which the metrics will be sent. Examples below: - `https://api.honeycomb.io:443/v1/metrics` - `https://ingest.eu0.signalfx.com/v2/datapoint/otlp`", alias="streamEndpointUrl")
|
||||
data_model_version: Optional[DataModelVersion] = Field(default=None, alias="dataModelVersion")
|
||||
@ -47,7 +49,7 @@ class CreateStreamResponse(BaseModel):
|
||||
filters: Optional[Filters] = None
|
||||
exporter_config: Optional[ExporterConfig] = Field(default=None, alias="exporterConfig")
|
||||
audit_operation: Optional[AuditOperation] = Field(default=None, alias="auditOperation")
|
||||
__properties: ClassVar[List[str]] = ["id", "enabled", "_links", "type", "endpointType", "streamEndpointUrl", "dataModelVersion", "customHeaders", "tagMatch", "testMatch", "filters", "exporterConfig", "auditOperation"]
|
||||
__properties: ClassVar[List[str]] = ["id", "enabled", "_links", "type", "signal", "endpointType", "streamEndpointUrl", "dataModelVersion", "customHeaders", "tagMatch", "testMatch", "filters", "exporterConfig", "auditOperation"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -133,6 +135,7 @@ class CreateStreamResponse(BaseModel):
|
||||
"enabled": obj.get("enabled"),
|
||||
"_links": StreamLinks.from_dict(obj["_links"]) if obj.get("_links") is not None else None,
|
||||
"type": obj.get("type"),
|
||||
"signal": obj.get("signal"),
|
||||
"endpointType": obj.get("endpointType"),
|
||||
"streamEndpointUrl": obj.get("streamEndpointUrl"),
|
||||
"dataModelVersion": obj.get("dataModelVersion"),
|
||||
|
||||
@ -19,7 +19,7 @@ from typing_extensions import Self
|
||||
|
||||
class DataModelVersion(str, Enum):
|
||||
"""
|
||||
The version of the data model used in the data stream. Default: `v2`
|
||||
The version of the data model used in the data stream. When using `v1`: - The `signal` cannot be `trace`. Default: `v2`
|
||||
"""
|
||||
|
||||
"""
|
||||
|
||||
@ -23,6 +23,7 @@ from thousandeyes_sdk.streaming.models.data_model_version import DataModelVersio
|
||||
from thousandeyes_sdk.streaming.models.endpoint_type import EndpointType
|
||||
from thousandeyes_sdk.streaming.models.exporter_config import ExporterConfig
|
||||
from thousandeyes_sdk.streaming.models.filters import Filters
|
||||
from thousandeyes_sdk.streaming.models.signal import Signal
|
||||
from thousandeyes_sdk.streaming.models.stream_links import StreamLinks
|
||||
from thousandeyes_sdk.streaming.models.stream_type import StreamType
|
||||
from thousandeyes_sdk.streaming.models.tag_match import TagMatch
|
||||
@ -38,6 +39,7 @@ class GetStreamResponse(BaseModel):
|
||||
enabled: Optional[StrictBool] = Field(default=None, description="Flag to enable or disable the stream integration.")
|
||||
links: Optional[StreamLinks] = Field(default=None, alias="_links")
|
||||
type: Optional[StreamType] = None
|
||||
signal: Optional[Signal] = None
|
||||
endpoint_type: Optional[EndpointType] = Field(default=None, alias="endpointType")
|
||||
stream_endpoint_url: Optional[StrictStr] = Field(default=None, description="The URL ThousandEyes sends data stream to. For a URL to be valid, it needs to: - Be syntactically correct. - Be reachable. - Use the HTTPS protocol. - When using the `grpc` endpointType, streamEndpointUrl cannot contain paths: - Valid . `grpc` - `https://example.com` - Invalid . `grpc` - `https://example.com/collector`. - Valid . `http` - `https://example.com/collector`. - When using the `http` endpointType, the operation must match the exact final full URL (including the path if there is one) to which the metrics will be sent. Examples below: - `https://api.honeycomb.io:443/v1/metrics` - `https://ingest.eu0.signalfx.com/v2/datapoint/otlp`", alias="streamEndpointUrl")
|
||||
data_model_version: Optional[DataModelVersion] = Field(default=None, alias="dataModelVersion")
|
||||
@ -47,7 +49,7 @@ class GetStreamResponse(BaseModel):
|
||||
filters: Optional[Filters] = None
|
||||
exporter_config: Optional[ExporterConfig] = Field(default=None, alias="exporterConfig")
|
||||
audit_operation: Optional[AuditOperationWithUpdate] = Field(default=None, alias="auditOperation")
|
||||
__properties: ClassVar[List[str]] = ["id", "enabled", "_links", "type", "endpointType", "streamEndpointUrl", "dataModelVersion", "customHeaders", "tagMatch", "testMatch", "filters", "exporterConfig", "auditOperation"]
|
||||
__properties: ClassVar[List[str]] = ["id", "enabled", "_links", "type", "signal", "endpointType", "streamEndpointUrl", "dataModelVersion", "customHeaders", "tagMatch", "testMatch", "filters", "exporterConfig", "auditOperation"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -133,6 +135,7 @@ class GetStreamResponse(BaseModel):
|
||||
"enabled": obj.get("enabled"),
|
||||
"_links": StreamLinks.from_dict(obj["_links"]) if obj.get("_links") is not None else None,
|
||||
"type": obj.get("type"),
|
||||
"signal": obj.get("signal"),
|
||||
"endpointType": obj.get("endpointType"),
|
||||
"streamEndpointUrl": obj.get("streamEndpointUrl"),
|
||||
"dataModelVersion": obj.get("dataModelVersion"),
|
||||
|
||||
@ -0,0 +1,41 @@
|
||||
# coding: utf-8
|
||||
|
||||
"""
|
||||
ThousandEyes for OpenTelemetry API
|
||||
|
||||
ThousandEyes for OpenTelemetry provides machine-to-machine integration between ThousandEyes and its customers. It allows you to export ThousandEyes telemetry data in OTel format, which is widely used in the industry. With ThousandEyes for OTel, you can leverage frameworks widely used in the observability domain - such as Splunk, Grafana, and Honeycomb - to capture and analyze ThousandEyes data. Any client that supports OTel can use ThousandEyes for OpenTelemetry. ThousandEyes for OTel is made up of the following components: * Data streaming APIs that you can use to configure and enable your ThousandEyes tests with OTel-compatible streams, in particular to configure how ThousandEyes telemetry data is exported to client integrations. * A set of streaming pipelines called _collectors_ that actively fetch ThousandEyes network test data, enrich the data with some additional detail, filter, and push the data to the customer-configured endpoints, depending on what you configure via the public APIs. * Third-party OTel collectors that receive, transform, filter, and export different metrics to client applications such as AppD, or any other OTel-capable client configuration. For more information about ThousandEyes for OpenTelemetry, see the [documentation](https://docs.thousandeyes.com/product-documentation/api/opentelemetry).
|
||||
|
||||
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
||||
|
||||
Do not edit the class manually.
|
||||
""" # noqa: E501
|
||||
|
||||
|
||||
from __future__ import annotations
|
||||
import json
|
||||
from enum import Enum
|
||||
from typing_extensions import Self
|
||||
|
||||
|
||||
class Signal(str, Enum):
|
||||
"""
|
||||
The OpenTelemetry signal of the stream integration. When using `trace`: - `dataModelVersion` must be `v2`. Default: `metric`
|
||||
"""
|
||||
|
||||
"""
|
||||
allowed enum values
|
||||
"""
|
||||
METRIC = 'metric'
|
||||
TRACE = 'trace'
|
||||
UNKNOWN = 'unknown'
|
||||
|
||||
@classmethod
|
||||
def from_json(cls, json_str: str) -> Self:
|
||||
"""Create an instance of Signal from a JSON string"""
|
||||
return cls(json.loads(json_str))
|
||||
|
||||
@classmethod
|
||||
def _missing_(cls, value):
|
||||
"""Handle unknown values"""
|
||||
return cls.UNKNOWN
|
||||
|
||||
@ -22,6 +22,7 @@ from thousandeyes_sdk.streaming.models.data_model_version import DataModelVersio
|
||||
from thousandeyes_sdk.streaming.models.endpoint_type import EndpointType
|
||||
from thousandeyes_sdk.streaming.models.exporter_config import ExporterConfig
|
||||
from thousandeyes_sdk.streaming.models.filters import Filters
|
||||
from thousandeyes_sdk.streaming.models.signal import Signal
|
||||
from thousandeyes_sdk.streaming.models.stream_type import StreamType
|
||||
from thousandeyes_sdk.streaming.models.tag_match import TagMatch
|
||||
from thousandeyes_sdk.streaming.models.test_match import TestMatch
|
||||
@ -39,10 +40,11 @@ class Stream(BaseModel):
|
||||
filters: Optional[Filters] = None
|
||||
exporter_config: Optional[ExporterConfig] = Field(default=None, alias="exporterConfig")
|
||||
type: Optional[StreamType] = None
|
||||
signal: Optional[Signal] = None
|
||||
endpoint_type: Optional[EndpointType] = Field(default=None, alias="endpointType")
|
||||
stream_endpoint_url: Optional[StrictStr] = Field(default=None, description="The URL ThousandEyes sends data stream to. For a URL to be valid, it needs to: - Be syntactically correct. - Be reachable. - Use the HTTPS protocol. - When using the `grpc` endpointType, streamEndpointUrl cannot contain paths: - Valid . `grpc` - `https://example.com` - Invalid . `grpc` - `https://example.com/collector`. - Valid . `http` - `https://example.com/collector`. - When using the `http` endpointType, the operation must match the exact final full URL (including the path if there is one) to which the metrics will be sent. Examples below: - `https://api.honeycomb.io:443/v1/metrics` - `https://ingest.eu0.signalfx.com/v2/datapoint/otlp`", alias="streamEndpointUrl")
|
||||
data_model_version: Optional[DataModelVersion] = Field(default=None, alias="dataModelVersion")
|
||||
__properties: ClassVar[List[str]] = ["customHeaders", "tagMatch", "testMatch", "enabled", "filters", "exporterConfig", "type", "endpointType", "streamEndpointUrl", "dataModelVersion"]
|
||||
__properties: ClassVar[List[str]] = ["customHeaders", "tagMatch", "testMatch", "enabled", "filters", "exporterConfig", "type", "signal", "endpointType", "streamEndpointUrl", "dataModelVersion"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -123,6 +125,7 @@ class Stream(BaseModel):
|
||||
"filters": Filters.from_dict(obj["filters"]) if obj.get("filters") is not None else None,
|
||||
"exporterConfig": ExporterConfig.from_dict(obj["exporterConfig"]) if obj.get("exporterConfig") is not None else None,
|
||||
"type": obj.get("type"),
|
||||
"signal": obj.get("signal"),
|
||||
"endpointType": obj.get("endpointType"),
|
||||
"streamEndpointUrl": obj.get("streamEndpointUrl"),
|
||||
"dataModelVersion": obj.get("dataModelVersion")
|
||||
|
||||
@ -62,6 +62,7 @@ class TestStreamingApi(unittest.TestCase):
|
||||
}
|
||||
},
|
||||
"type" : "opentelemetry",
|
||||
"signal" : "metric",
|
||||
"dataModelVersion" : "v2",
|
||||
"customHeaders" : {
|
||||
"Authorization" : "*****",
|
||||
@ -114,6 +115,7 @@ class TestStreamingApi(unittest.TestCase):
|
||||
"value" : "valueB"
|
||||
} ],
|
||||
"id" : "342ieu09",
|
||||
"signal" : "metric",
|
||||
"auditOperation" : {
|
||||
"createdDate" : 1679677853573,
|
||||
"createdBy" : 3962
|
||||
@ -175,6 +177,7 @@ class TestStreamingApi(unittest.TestCase):
|
||||
"value" : "valueB"
|
||||
} ],
|
||||
"id" : "342ieu09",
|
||||
"signal" : "metric",
|
||||
"auditOperation" : {
|
||||
"createdDate" : 1679677853573,
|
||||
"updatedBy" : 3962,
|
||||
@ -234,6 +237,7 @@ class TestStreamingApi(unittest.TestCase):
|
||||
"value" : "valueB"
|
||||
} ],
|
||||
"id" : "342ieu09",
|
||||
"signal" : "metric",
|
||||
"auditOperation" : {
|
||||
"createdDate" : 1679677853573,
|
||||
"updatedBy" : 3962,
|
||||
@ -283,6 +287,7 @@ class TestStreamingApi(unittest.TestCase):
|
||||
"value" : "valueB"
|
||||
} ],
|
||||
"id" : "342ieu09",
|
||||
"signal" : "metric",
|
||||
"auditOperation" : {
|
||||
"createdDate" : 1679677853573,
|
||||
"updatedBy" : 3962,
|
||||
@ -384,6 +389,7 @@ class TestStreamingApi(unittest.TestCase):
|
||||
"value" : "valueB"
|
||||
} ],
|
||||
"id" : "342ieu09",
|
||||
"signal" : "metric",
|
||||
"auditOperation" : {
|
||||
"createdDate" : 1679677853573,
|
||||
"updatedBy" : 3962,
|
||||
|
||||
@ -16,7 +16,7 @@ Things to note with the ThousandEyes Tags API:
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ Get test result metrics for Cloud and Enterprise Agent tests.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ This API supports listing, creating, editing, and deleting Cloud and Enterprise
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ Refer to the Usage API operations for detailed usage instructions and optional p
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.25
|
||||
- API version: 7.0.26
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user