Annotation Type LoadBalancerAttribute


  • @Retention(RUNTIME)
    @Target(TYPE)
    @Repeatable(LoadBalancerAttributes.class)
    public @interface LoadBalancerAttribute
    Defines an attribute for a load balancer. The name of the attribute corresponds to the value used in the configuration, e.g. for name my-attribute, use the following to set the value: stork.<my-service>.load-balancer.my-attribute In the configuration class generated for the load balancer, this attribute will be exposed through getMyAttribute()
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String description
      Description of the attribute.
      String name
      Attribute name as used in the configuration.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String defaultValue
      Default value for the attribute.
      boolean required
      Whether the attribute is mandatory or optional
    • Element Detail

      • name

        String name
        Attribute name as used in the configuration. Exposed through a getter with name converted to camelCase with characters that cannot be used in a java identifiers filtered out.
        Returns:
        the name of the configuration property
      • description

        String description
        Description of the attribute. Works best in the documentation if it starts with a capital letter and ends with period.
        Returns:
        the description
      • defaultValue

        String defaultValue
        Default value for the attribute. If not provided and user didn't set the value - null will be passed
        Returns:
        the default value
        Default:
        "__$$_DEFAULT_VALUE_$$__"
      • required

        boolean required
        Whether the attribute is mandatory or optional
        Returns:
        true if the attribute is required, false otherwise
        Default:
        false