Package com.xebialabs.deployit.plugin.api.rules

## Annotation Type StepParameter

-     @Documented
      @Retention(RUNTIME)
      @Target(FIELD)
      public @interface StepParameter

- - ### Required Element Summary

    Required Elements
    Modifier and Type | Required Element | Description
    --- | --- | ---
    `java.lang.String` | `description` |

  - ### Optional Element Summary

    Optional Elements
    Modifier and Type | Optional Element | Description
    --- | --- | ---
    `boolean` | `calculated` |
    `java.lang.String` | `name` |
    `boolean` | `required` |

- - ### Element Detail

    - #### description

          java.lang.String description

      Returns:
        Description of the parameter.

  - - #### name

          java.lang.String name

      Returns:
        Name of the step parameter as used in xml.
      Default:
        ""

  - - #### required

          boolean required

      Returns:
        whether or not this parameter is required. Defaults to true.
      Default:
        true

  - - #### calculated

          boolean calculated

      Returns:
        whether or not value for this parameter is calculated by rule engine. Defaults to false.
      Default:
        false