Package com.azure.resourcemanager.videoanalyzer.fluent.models

Class LivePipelinePropertiesUpdate

  • public final class LivePipelinePropertiesUpdate
extends Object
    Live pipeline properties.

    • Constructor Detail

      • LivePipelinePropertiesUpdate

        public LivePipelinePropertiesUpdate()

    • Method Detail

      • topologyName

        public String topologyName()
        Get the topologyName property: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
        Returns:
        the topologyName value.

      • withTopologyName

        public LivePipelinePropertiesUpdate withTopologyName​(String topologyName)
        Set the topologyName property: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
        Parameters:
        topologyName - the topologyName value to set.
        Returns:
        the LivePipelinePropertiesUpdate object itself.

      • description

        public String description()
        Get the description property: An optional description for the pipeline.
        Returns:
        the description value.

      • withDescription

        public LivePipelinePropertiesUpdate withDescription​(String description)
        Set the description property: An optional description for the pipeline.
        Parameters:
        description - the description value to set.
        Returns:
        the LivePipelinePropertiesUpdate object itself.

      • bitrateKbps

        public Integer bitrateKbps()
        Get the bitrateKbps property: Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
        Returns:
        the bitrateKbps value.

      • withBitrateKbps

        public LivePipelinePropertiesUpdate withBitrateKbps​(Integer bitrateKbps)
        Set the bitrateKbps property: Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.
        Parameters:
        bitrateKbps - the bitrateKbps value to set.
        Returns:
        the LivePipelinePropertiesUpdate object itself.

      • state

        public LivePipelineState state()
        Get the state property: Current state of the pipeline (read-only).
        Returns:
        the state value.

      • parameters

        public List<ParameterDefinition> parameters()
        Get the parameters property: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
        Returns:
        the parameters value.

      • withParameters

        public LivePipelinePropertiesUpdate withParameters​(List<ParameterDefinition> parameters)
        Set the parameters property: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
        Parameters:
        parameters - the parameters value to set.
        Returns:
        the LivePipelinePropertiesUpdate object itself.

      • validate

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