Package com.azure.resourcemanager.videoanalyzer.models

Class 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 pipelines.

    • Constructor Detail

      • ParameterDeclaration

        public ParameterDeclaration()

    • Method Detail

      • name

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

      • withName

        public ParameterDeclaration withName​(String name)
        Set the name property: Name of the parameter.
        Parameters:
        name - the name value to set.
        Returns:
        the ParameterDeclaration object itself.

      • type

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

      • withType

        public ParameterDeclaration withType​(ParameterType type)
        Set the type property: Type of the parameter.
        Parameters:
        type - the type value to set.
        Returns:
        the ParameterDeclaration object itself.

      • description

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

      • withDescription

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

      • defaultProperty

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

      • withDefaultProperty

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

      • validate

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