Package com.azure.media.videoanalyzer.edge.models

Class ParameterDeclaration

java.lang.Object
com.azure.media.videoanalyzer.edge.models.ParameterDeclaration
public final class ParameterDeclaration extends Object
Single topology parameter declaration. Declared parameters can and must be referenced throughout the topology and can optionally have default values to be used when they are not defined in the pipeline instances.

  • Constructor Details

    • ParameterDeclaration

      public ParameterDeclaration(String name, ParameterType type)
      Creates an instance of ParameterDeclaration class.
      Parameters:
      name - the name value to set.
      type - the type value to set.

  • Method Details

    • getName

      public String getName()
      Get the name property: Name of the parameter.
      Returns:
      the name value.

    • getType

      public ParameterType getType()
      Get the type property: Type of the parameter.
      Returns:
      the type value.

    • getDescription

      public String getDescription()
      Get the description property: Description of the parameter.
      Returns:
      the description value.

    • setDescription

      public ParameterDeclaration setDescription(String description)
      Set the description property: Description of the parameter.
      Parameters:
      description - the description value to set.
      Returns:
      the ParameterDeclaration object itself.

    • getDefaultProperty

      public String getDefaultProperty()
      Get the defaultProperty property: The default value for the parameter to be used if the live pipeline does not specify a value.
      Returns:
      the defaultProperty value.

    • setDefaultProperty

      public ParameterDeclaration setDefaultProperty(String defaultProperty)
      Set the defaultProperty property: The default value for the parameter to be used if the live pipeline does not specify a value.
      Parameters:
      defaultProperty - the defaultProperty value to set.
      Returns:
      the ParameterDeclaration object itself.