Class PipelineTopologySetRequestBody


  • public final class PipelineTopologySetRequestBody
    extends MethodRequest
    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.

    • Constructor Detail

      • PipelineTopologySetRequestBody

        public PipelineTopologySetRequestBody​(String name)
        Creates an instance of PipelineTopologySetRequestBody class.
        Parameters:
        name - the name value to set.
    • Method Detail

      • getName

        public String getName()
        Get the name property: Pipeline topology unique identifier.
        Returns:
        the name value.
      • getSystemData

        public SystemData getSystemData()
        Get the systemData property: Read-only system metadata associated with this object.
        Returns:
        the systemData value.
      • setSystemData

        public PipelineTopologySetRequestBody setSystemData​(SystemData systemData)
        Set the systemData property: Read-only system metadata associated with this object.
        Parameters:
        systemData - the systemData value to set.
        Returns:
        the PipelineTopologySetRequestBody object itself.
      • getProperties

        public PipelineTopologyProperties getProperties()
        Get the properties property: Pipeline topology properties.
        Returns:
        the properties value.
      • setProperties

        public PipelineTopologySetRequestBody setProperties​(PipelineTopologyProperties properties)
        Set the properties property: Pipeline topology properties.
        Parameters:
        properties - the properties value to set.
        Returns:
        the PipelineTopologySetRequestBody object itself.