thousandeyes-sdk-python/thousandeyes-sdk-streaming/docs/CreateStreamResponse.md
2025-04-30 14:47:06 +00:00

44 lines
2.9 KiB
Markdown

# CreateStreamResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The data stream ID | [optional] [readonly]
**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 data 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]
**custom_headers** | **Dict[str, str]** | Custom headers. | [optional]
**tag_match** | [**List[TagMatch]**](TagMatch.md) | A collection of tags that determine what tests are included in the data stream. These tag values are also included as attributes in the data stream metrics. | [optional]
**test_match** | [**List[TestMatch]**](TestMatch.md) | A collection of tests to be included in the data stream. | [optional]
**filters** | [**Filters**](Filters.md) | | [optional]
**exporter_config** | [**ExporterConfig**](ExporterConfig.md) | | [optional]
**audit_operation** | [**AuditOperation**](AuditOperation.md) | | [optional]
**stream_status** | [**StreamStatus**](StreamStatus.md) | | [optional]
## Example
```python
from thousandeyes_sdk.streaming.models.create_stream_response import CreateStreamResponse
# TODO update the JSON string below
json = "{}"
# create an instance of CreateStreamResponse from a JSON string
create_stream_response_instance = CreateStreamResponse.from_json(json)
# print the JSON string representation of the object
print(CreateStreamResponse.to_json())
# convert the object into a dict
create_stream_response_dict = create_stream_response_instance.to_dict()
# create an instance of CreateStreamResponse from a dict
create_stream_response_from_dict = CreateStreamResponse.from_dict(create_stream_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)