Package io.bdeploy.api.deploy.v1

Class InstanceDeploymentInformationApi

java.lang.Object

io.bdeploy.api.deploy.v1.InstanceDeploymentInformationApi

public class InstanceDeploymentInformationApi
extends Object

Describes a deployments current state. This object is persisted to a file. To retrieve the path to the file in an app-info.yaml use the {{I:DEPLOYMENT_INFO_FILE}} expansion.

The file containing this object is updated whenever BDeploy updates the deployment of this instance. Thus it can be consumed by applications to detect changes to the current deployment states.

This file is available for server applications only. The client launcher does not provide this file.

Field Summary

Fields

Modifier and Type	Field	Description
String	activeInstanceVersion	The currently active instance version.
static final String	FILE_NAME
InstanceConfigurationApi	instance	The instance this information refers to.

Constructor Summary

Constructors

Constructor	Description
InstanceDeploymentInformationApi()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

FILE_NAME

public static final String FILE_NAME

See Also:

• Constant Field Values

activeInstanceVersion

public String activeInstanceVersion

The currently active instance version.

instance

public InstanceConfigurationApi instance

The instance this information refers to. The information refers to the currently active instance version.

Note that the description field is currently always empty in this scenario.

Constructor Details

InstanceDeploymentInformationApi

public InstanceDeploymentInformationApi()