Skip to content

Class: Parameter

Defines a configurable parameter for the application.

 classDiagram
    class Parameter
    click Parameter href "../Parameter/"
      Parameter : name

      Parameter : targets





        Parameter --> "1..*" Target : targets
        click Target href "../Target/"



      Parameter : value

Attributes

Name Cardinality and Range Description Inheritance
name 1
string		 Name of the parameter direct
value 0..1
double or 
boolean or 
string or 
integer		 The parameter's default value direct
targets 1..*
Target		 Used to indicate which component the value should be applied to when installi... direct

Usages

used by used in type used
Spec parameters range Parameter
ApplicationDescription parameters range Parameter
This section is only relevant for contributors of the specification

LinkML Source

Direct

Details 
name: Parameter
description: Defines a configurable parameter for the application.
from_schema: https://specification.margo.org/data-model
attributes:
  name:
    name: name
    description: Name of the parameter.
    from_schema: https://specification.margo.org/deployments
    identifier: true
    domain_of:
    - Component
    - Parameter
    - DeploymentMetadata
    - ApplicationMetadata
    - Author
    - Organization
    - Section
    - Setting
    - Schema
    - ComponentStatus
    range: string
    required: true
  value:
    name: value
    description: The parameter's default value.  Accepted data types are string, integer,
      double, boolean, array[string], array[integer], array[double], array[boolean].
    from_schema: https://specification.margo.org/deployments
    domain_of:
    - Parameter
    any_of:
    - range: boolean
    - range: integer
    - range: double
    - range: string
  targets:
    name: targets
    description: Used to indicate which component the value should be applied to when
      installing, or updating, the application.  See the [Target](#target-attributes)
      section below.
    from_schema: https://specification.margo.org/deployments
    domain_of:
    - Parameter
    range: Target
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true

Induced

Details 
name: Parameter
description: Defines a configurable parameter for the application.
from_schema: https://specification.margo.org/data-model
attributes:
  name:
    name: name
    description: Name of the parameter.
    from_schema: https://specification.margo.org/deployments
    identifier: true
    alias: name
    owner: Parameter
    domain_of:
    - Component
    - Parameter
    - DeploymentMetadata
    - ApplicationMetadata
    - Author
    - Organization
    - Section
    - Setting
    - Schema
    - ComponentStatus
    range: string
    required: true
  value:
    name: value
    description: The parameter's default value.  Accepted data types are string, integer,
      double, boolean, array[string], array[integer], array[double], array[boolean].
    from_schema: https://specification.margo.org/deployments
    alias: value
    owner: Parameter
    domain_of:
    - Parameter
    any_of:
    - range: boolean
    - range: integer
    - range: double
    - range: string
  targets:
    name: targets
    description: Used to indicate which component the value should be applied to when
      installing, or updating, the application.  See the [Target](#target-attributes)
      section below.
    from_schema: https://specification.margo.org/deployments
    alias: targets
    owner: Parameter
    domain_of:
    - Parameter
    range: Target
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true