Package com.azure.resourcemanager.videoanalyzer.models

Interface LivePipeline

  • public interface LivePipeline
    An immutable client-side representation of LivePipeline.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void activate()
      Activates a live pipeline with the given name.
      void activate​(com.azure.core.util.Context context)
      Activates a live pipeline with the given name.
      int bitrateKbps()
      Gets the bitrateKbps property: Maximum bitrate capacity in Kbps reserved for the live pipeline.
      void deactivate()
      Deactivates a live pipeline with the given name.
      void deactivate​(com.azure.core.util.Context context)
      Deactivates a live pipeline with the given name.
      String description()
      Gets the description property: An optional description for the pipeline.
      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      LivePipelineInner innerModel()
      Gets the inner com.azure.resourcemanager.videoanalyzer.fluent.models.LivePipelineInner object.
      String name()
      Gets the name property: The name of the resource.
      List<ParameterDefinition> parameters()
      Gets the parameters property: List of the instance level parameter values for the user-defined topology parameters.
      LivePipeline refresh()
      Refreshes the resource to sync with Azure.
      LivePipeline refresh​(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      String resourceGroupName()
      Gets the name of the resource group.
      LivePipelineState state()
      Gets the state property: Current state of the pipeline (read-only).
      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      String topologyName()
      Gets the topologyName property: The reference to an existing pipeline topology defined for real-time content processing.
      String type()
      Gets the type property: The type of the resource.
      LivePipeline.Update update()
      Begins update for the LivePipeline resource.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • systemData

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

      • topologyName

        String topologyName()
        Gets 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.

      • description

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

      • bitrateKbps

        int bitrateKbps()
        Gets 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.

      • state

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

      • parameters

        List<ParameterDefinition> parameters()
        Gets 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.

      • resourceGroupName

        String resourceGroupName()
        Gets the name of the resource group.
        Returns:
        the name of the resource group.

      • innerModel

        LivePipelineInner innerModel()
        Gets the inner com.azure.resourcemanager.videoanalyzer.fluent.models.LivePipelineInner object.
        Returns:
        the inner object.

      • update

        LivePipeline.Update update()
        Begins update for the LivePipeline resource.
        Returns:
        the stage of resource update.

      • refresh

        LivePipeline refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        LivePipeline refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • activate

        void activate()
        Activates a live pipeline with the given name.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • activate

        void activate​(com.azure.core.util.Context context)
        Activates a live pipeline with the given name.
        Parameters:
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • deactivate

        void deactivate()
        Deactivates a live pipeline with the given name.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • deactivate

        void deactivate​(com.azure.core.util.Context context)
        Deactivates a live pipeline with the given name.
        Parameters:
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.