Package io.bdeploy.api.product.v1

Class ProductVersionDescriptor

java.lang.Object

io.bdeploy.api.product.v1.ProductVersionDescriptor

@JsonClassDescription("A typically generated information describing the \'current build\' of a product version.")
public class ProductVersionDescriptor
extends Object

Contains potentially dynamic information relevant when creating a product

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,Map<OsHelper.OperatingSystem,String>>	appInfo	A mapping of application names (defined in ProductDescriptor.applications) to OsHelper.OperatingSystem specific relative paths to app-info.yaml files.
Map<String,String>	labels	A map of additional labels to add to the product manifest once generated.
String	version	The "version" of the product.

Constructor Summary

Constructors

Constructor	Description
ProductVersionDescriptor()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

version

@JsonPropertyDescription("The \'version\' of the product. This version is used for the product and all included applications. The format is product specific, although diversion from standard semantic versioning format may require contributing plugins with custom sorting logic.")
public String version

The "version" of the product. This version is used as tag for all created Manifests associated with the product (the product's own Manifest and one Manifest per application created).

appInfo

@JsonPropertyDescription("Mapping of application IDs as used in \'product-info.yaml\' to paths to directories per supported operating system. Multiple operating systems may point to the same path. The path may point to the directory where the \'app-info.yaml\' file is located, or to the \'app-info.yaml\' file directly.")
public Map<String,Map<OsHelper.OperatingSystem,String>> appInfo

A mapping of application names (defined in ProductDescriptor.applications) to OsHelper.OperatingSystem specific relative paths to app-info.yaml files. It is assumed that the app-info.yaml file is located in the root directory of the actual application build, so that the app-info.yaml's parent directory is regarded as application directory to import into the product.

labels

@JsonPropertyDescription("Additional meta-information to associate with the product. This information is shown to the user in the Web UI, and has no other use.")
public Map<String,String> labels

A map of additional labels to add to the product manifest once generated.

See Also:

• Manifest.getLabels()

Constructor Details

ProductVersionDescriptor

public ProductVersionDescriptor()