Package com.azure.resourcemanager.videoanalyzer.models

Class PipelineTopologyUpdate

  • public final class PipelineTopologyUpdate
extends com.azure.core.management.ProxyResource
    Pipeline topology describes the processing steps to be applied when processing content 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 captures content from a RTSP camera and archives the content can be reused across many different cameras, as long as the same processing is to 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. This allows individual pipelines 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 content 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

      • PipelineTopologyUpdate

        public PipelineTopologyUpdate()

    • Method Detail

      • kind

        public Kind kind()
        Get the kind property: Topology kind.
        Returns:
        the kind value.

      • withKind

        public PipelineTopologyUpdate withKind​(Kind kind)
        Set the kind property: Topology kind.
        Parameters:
        kind - the kind value to set.
        Returns:
        the PipelineTopologyUpdate object itself.

      • sku

        public Sku sku()
        Get the sku property: Describes the properties of a SKU.
        Returns:
        the sku value.

      • withSku

        public PipelineTopologyUpdate withSku​(Sku sku)
        Set the sku property: Describes the properties of a SKU.
        Parameters:
        sku - the sku value to set.
        Returns:
        the PipelineTopologyUpdate object itself.

      • systemData

        public com.azure.core.management.SystemData systemData()
        Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
        Returns:
        the systemData value.

      • description

        public String description()
        Get the description property: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.
        Returns:
        the description value.

      • withDescription

        public PipelineTopologyUpdate withDescription​(String description)
        Set the description property: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.
        Parameters:
        description - the description value to set.
        Returns:
        the PipelineTopologyUpdate object itself.

      • parameters

        public List<ParameterDeclaration> parameters()
        Get the parameters property: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline.
        Returns:
        the parameters value.

      • withParameters

        public PipelineTopologyUpdate withParameters​(List<ParameterDeclaration> parameters)
        Set the parameters property: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline.
        Parameters:
        parameters - the parameters value to set.
        Returns:
        the PipelineTopologyUpdate object itself.

      • sources

        public List<SourceNodeBase> sources()
        Get the sources property: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
        Returns:
        the sources value.

      • withSources

        public PipelineTopologyUpdate withSources​(List<SourceNodeBase> sources)
        Set the sources property: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
        Parameters:
        sources - the sources value to set.
        Returns:
        the PipelineTopologyUpdate object itself.

      • processors

        public List<ProcessorNodeBase> processors()
        Get the processors property: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
        Returns:
        the processors value.

      • withProcessors

        public PipelineTopologyUpdate withProcessors​(List<ProcessorNodeBase> processors)
        Set the processors property: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
        Parameters:
        processors - the processors value to set.
        Returns:
        the PipelineTopologyUpdate object itself.

      • sinks

        public List<SinkNodeBase> sinks()
        Get the sinks property: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
        Returns:
        the sinks value.

      • withSinks

        public PipelineTopologyUpdate withSinks​(List<SinkNodeBase> sinks)
        Set the sinks property: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
        Parameters:
        sinks - the sinks value to set.
        Returns:
        the PipelineTopologyUpdate object itself.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.