PipelineTopologySetRequest Class

Creates a new pipeline topology or updates an existing one.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.media.videoanalyzeredge._generated.models._models_py3.MethodRequest
PipelineTopologySetRequest

Constructor

PipelineTopologySetRequest(*, pipeline_topology: azure.media.videoanalyzeredge._generated.models._models_py3.PipelineTopology, api_version: Optional[str] = '1.1', **kwargs)

Variables

method_name
str

Required. Direct method method name.Constant filled by server.

api_version
str

Video Analyzer API version. The only acceptable values to pass in are None and "1.1". The default value is "1.1".

pipeline_topology
<xref:azure.media.videoanalyzer.edge.models.PipelineTopology>

Required. Pipeline topology describes the processing steps to be applied when processing media for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which acquires data from a RTSP camera, process it with an specific AI model and stored the data on the cloud can be reused across many different cameras, as long as the same processing should be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized, thus allowing individual pipelines to refer to different values, such as individual cameras RTSP endpoints and credentials. Overall a topology is composed of the following:

  • Parameters: list of user defined parameters that can be references across the topology

nodes.

  • Sources: list of one or more data sources nodes such as an RTSP source which allows for media to be ingested from cameras.

  • Processors: list of nodes which perform data analysis or transformations.

    -Sinks: list of one or more data sinks which allow for data to be stored or exported to

other destinations.

Methods

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize()

Parameters

keep_readonly
bool
Required

If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type