Package io.bdeploy.api.product.v1

Class ProductDescriptor

java.lang.Object
io.bdeploy.api.product.v1.ProductDescriptor
@JsonClassDescription("Describes a product (name, key, included applications, capabilities, ...). Only includes the build/version independent configuration.") public class ProductDescriptor extends Object

  • Field Details

    • name

      @JsonPropertyDescription("The human readable name of the product.") public String name

    • product

      @JsonPropertyDescription("The (path-friendly) ID of the product, e.g. \'io.bdeploy/product\'") public String product
      The base-key of the product. This is used to construct:
      • The actual key of the products Manifest. (e.g. "{product}/product")
      • The actual key of included applications which are created when creating the product (e.g. "{product}/applications/{app}").

    • vendor

      @JsonPropertyDescription("The name of the vendor of the product.") public String vendor

    • applications

      @JsonPropertyDescription("A list of applications included in the product. Those applications must be available at build time, provided through \'product-version.yaml\'.") public List<String> applications

    • configTemplates

      @JsonPropertyDescription("A relative path (from product-info.yaml) to a directory containing an arbitrary amount of configuration files used as templates for new instances.") public String configTemplates

    • pluginFolder

      @JsonPropertyDescription("A relative path (from product-info.yaml) to a directory containing plugins which are to be made available dynamically when configuring an instance using this product.") public String pluginFolder

    • instanceTemplates

      @JsonPropertyDescription("A list of relative paths to (\'instance-template.yaml\') YAML files containing instance templates.") public List<String> instanceTemplates

    • applicationTemplates

      @JsonPropertyDescription("A list of relative paths to (\'application-template.yaml\') YAML files containing application templates.") public List<String> applicationTemplates

    • parameterTemplates

      @JsonPropertyDescription("A list of relative paths to (\'parameter-template.yaml\') YAML files containing parameter templates.") public List<String> parameterTemplates

    • instanceVariableTemplates

      @JsonPropertyDescription("A list of relative paths to (\'instance-variable-template.yaml\') YAML files containing instance variable templates.") public List<String> instanceVariableTemplates

    • versionFile

      @JsonPropertyDescription("A relative path to the mandatory \'product-version.yaml\' file which defines versions and available applications.") public String versionFile

  • Constructor Details

    • ProductDescriptor

      public ProductDescriptor()