thousandeyes-sdk-python/thousandeyes-sdk-streaming/docs/Stream.md
2024-07-31 13:16:19 +00:00

2.4 KiB

Stream

Properties

Name Type Description Notes
custom_headers Dict[str, str] Custom headers. Note: When using the `splunk-hec` `type`, the `customHeaders` must contain just one element with the key `token` and the value of the Splunk HEC Token. [optional]
tag_match **List[TagMatch]** 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]** A collection of tests to be included in the data stream. [optional]
enabled bool Flag to enable or disable the stream integration. [optional]
type StreamType [optional]
endpoint_type EndpointType [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 endpoint 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 [optional]

Example

from thousandeyes_sdk.streaming.models.stream import Stream

# TODO update the JSON string below
json = "{}"
# create an instance of Stream from a JSON string
stream_instance = Stream.from_json(json)
# print the JSON string representation of the object
print(Stream.to_json())

# convert the object into a dict
stream_dict = stream_instance.to_dict()
# create an instance of Stream from a dict
stream_from_dict = Stream.from_dict(stream_dict)

[Back to Model list] [Back to API list] [Back to README]