core

const (
	// DiagnosticLevelError should be used for diagnostics that point out
	// errors in a blueprint.
	// This is not solely used as a source of errors, this should be combined
	// with unpacking a returned error to produce a set of error diagnostics
	// for tools that report diagnostics. (e.g. language servers)
	DiagnosticLevelError DiagnosticLevel = 1
	// DiagnosticLevelWarning should be used for diagnostics that point out
	// potential issues that may occur when executing a blueprint.
	DiagnosticLevelWarning DiagnosticLevel = 2
	// DiagnosticLevelInfo should be used for diagnostics that provide
	// informational messages about the blueprint that are worth noting
	// but do not indicate issues that may occur when executing a blueprint.
	DiagnosticLevelInfo DiagnosticLevel = 3
)

const (
	// ErrorCoreReasonCodeInvalidMappingNode is provided
	// when a mapping node can not be parsed from a serialised blueprint.
	ErrorCoreReasonCodeInvalidMappingNode ErrorCoreReasonCode = "invalid_mapping_node"
	// ErrorCoreReasonCodeMissingMappingNode is provided
	// when a mapping node is missing a value in a serialised blueprint.
	ErrorCoreReasonCodeMissingMappingNode ErrorCoreReasonCode = "missing_mapping_node"
	// ErrorCoreReasonCodeMustBeScalar is an error that is returned
	// when a value that is expected to be a blueprint scalar is not a scalar value.
	ErrorCoreReasonCodeMustBeScalar ErrorCoreReasonCode = "must_be_scalar"
)

const (
	// ErrInvalidMappingPath is used when a path to access a value
	// in a MappingNode is invalid.
	ErrInvalidMappingPath ErrorCoreReasonCode = "invalid_mapping_path"
)

const (
	// InstanceStatusPreparing is used when a blueprint
	// instance is being prepared to be deployed, updated
	// or destroyed.
	InstanceStatusPreparing InstanceStatus = iota
	// InstanceStatusDeploying is used when
	// an initial blueprint deployment is currently in progress.
	InstanceStatusDeploying
	// InstanceStatusDeployed is used when
	// a blueprint instance has been deployed
	// successfully.
	InstanceStatusDeployed
	// InstanceStatusDeployFailed is used when
	// the first deployment of a blueprint instance failed.
	InstanceStatusDeployFailed
	// InstanceStatusDeployRollingBack is used when
	// a blueprint instance deployment has failed
	// and is being rolled back to a previous state.
	InstanceStatusDeployRollingBack
	// InstanceStatusDeployRollbackFailed is used when
	// a blueprint instance deployment has failed
	// and the rollback process has also failed.
	InstanceStatusDeployRollbackFailed
	// InstanceStatusDeployRollbackComplete is used when
	// a blueprint instance deployment has been successfully rolled back
	// to a previous state.
	InstanceStatusDeployRollbackComplete
	// InstanceStatusDestroying is used when
	// all the resources defined in a blueprint
	// are in the process of being destroyed
	// for a given instance.
	InstanceStatusDestroying
	// InstanceStatusDestroyed is used when
	// all resources defined in a blueprint have been destroyed
	// for a given instance.
	InstanceStatusDestroyed
	// InstanceStatusDestroyFailed is used when
	// the destruction of all resources in a blueprint fails.
	InstanceStatusDestroyFailed
	// InstanceStatusDestroyRollingBack is used when
	// a blueprint instance removal has failed
	// and is being rolled back to a previous state.
	InstanceStatusDestroyRollingBack
	// InstanceStatusDestroyRollbackFailed is used when
	// a blueprint instance removal has failed
	// and the rollback process has also failed.
	InstanceStatusDestroyRollbackFailed
	// InstanceStatusDeployRollbackComplete is used when
	// a blueprint instance removal has been successfully rolled back
	// to a previous state.
	InstanceStatusDestroyRollbackComplete
	// InstanceStatusUpdating is used when
	// a blueprint instance is being updated.
	InstanceStatusUpdating
	// InstanceStatusUpdated is used when a blueprint
	// instance has been sucessfully updated.
	InstanceStatusUpdated
	// InstanceStatusUpdateFailed is used when a blueprint
	// instance has failed to update.
	InstanceStatusUpdateFailed
	// InstanceStatusUpdateRollingBack is used when
	// a blueprint instance update has failed
	// and is being rolled back to a previous state.
	InstanceStatusUpdateRollingBack
	// InstanceStatusUpdateRollbackFailed is used when
	// a blueprint instance update has failed
	// and the rollback process has also failed.
	InstanceStatusUpdateRollbackFailed
	// InstanceStatusUpdateRollbackComplete is used when
	// a blueprint instance update has been successfully rolled back
	// to a previous state.
	InstanceStatusUpdateRollbackComplete
	// InstanceStatusNotDeployed is used when
	// a blueprint instance has not had its first deployment.
	// This is useful for persisting a skeleton for an instance
	// before the first deployment of a new blueprint instance.
	InstanceStatusNotDeployed
	// InstanceStatusDeployInterrupted is used when
	// a blueprint instance deployment was interrupted due to
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the instance is unknown and needs reconciliation.
	InstanceStatusDeployInterrupted
	// InstanceStatusUpdateInterrupted is used when
	// a blueprint instance update was interrupted due to
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the instance is unknown and needs reconciliation.
	InstanceStatusUpdateInterrupted
	// InstanceStatusDestroyInterrupted is used when
	// a blueprint instance destruction was interrupted due to
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the instance is unknown and needs reconciliation.
	InstanceStatusDestroyInterrupted
)

const (
	// LinkStatusUnknown is used when we can't
	// determine an accurate status for a link.
	LinkStatusUnknown LinkStatus = iota
	// LinkStatusCreating is used when
	// an initial link deployment is currently in progress.
	LinkStatusCreating
	// LinkStatusCreated is used when
	// a link has been deployed
	// successfully.
	LinkStatusCreated
	// LinkStatusCreateFailed is used when
	// the first creation of a link failed.
	LinkStatusCreateFailed
	// LinkStatusCreateRollingBack is used when
	// another change in the same blueprint has failed
	// and the creation of the current link is being rolled back.
	LinkStatusCreateRollingBack
	// LinkStatusCreateRollbackFailed is used when
	// another element change in the same blueprint has failed
	// and the creation of the current link could not be rolled back.
	LinkStatusCreateRollbackFailed
	// LinkStatusCreateRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the creation of the current link has been rolled back.
	LinkStatusCreateRollbackComplete
	// LinkStatusDestroying is used when
	// a link is in the process of being destroyed.
	LinkStatusDestroying
	// LinkStatusDestroyed is used when
	// a link has been destroyed.
	LinkStatusDestroyed
	// LinkStatusDestroyFailed is used when
	// the destruction of a link fails.
	LinkStatusDestroyFailed
	// LinkStatusDestroyRollingBack is used when
	// another change in the same blueprint has failed
	// and the removal of the current link is being rolled back.
	LinkStatusDestroyRollingBack
	// LinkStatusDestroyRollbackFailed is used when
	// another resource change in the same blueprint has failed
	// and the removal of the current link could not be rolled back.
	LinkStatusDestroyRollbackFailed
	// LinkStatusDestroyRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the removal of the current link has been rolled back.
	LinkStatusDestroyRollbackComplete
	// LinkStatusUpdating is used when
	// a link is being updated.
	LinkStatusUpdating
	// LinkStatusUpdated is used when a link
	// has been sucessfully updated.
	LinkStatusUpdated
	// LinkStatusUpdateFailed is used when a link
	// has failed to update.
	LinkStatusUpdateFailed
	// LinkStatusUpdateRollingBack is used when
	// another change in the same blueprint has failed
	// and the latest changes made to
	// the current link are being rolled back.
	LinkStatusUpdateRollingBack
	// LinkStatusUpdateRollbackFailed is used when
	// another resource change in the same blueprint has failed
	// and the latest changes made to
	// the current link could not be rolled back.
	LinkStatusUpdateRollbackFailed
	// LinkStatusUpdateRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the latest changes made to
	// the current link have been rolled back.
	LinkStatusUpdateRollbackComplete
	// LinkStatusCreateInterrupted is used when
	// a link creation was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the link is unknown and needs reconciliation.
	LinkStatusCreateInterrupted
	// LinkStatusUpdateInterrupted is used when
	// a link update was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the link is unknown and needs reconciliation.
	LinkStatusUpdateInterrupted
	// LinkStatusDestroyInterrupted is used when
	// a link destruction was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the link is unknown and needs reconciliation.
	LinkStatusDestroyInterrupted
)

const (
	// StringLogFieldType represents a log field with a string value.
	StringLogFieldType LogFieldType = iota
	// IntegerLogFieldType represents a log field with an integer value.
	IntegerLogFieldType
	// FloatLogFieldType represents a log field with a float value.
	FloatLogFieldType
	// BoolLogFieldType represents a log field with a boolean value.
	BoolLogFieldType
	// ErrorLogFieldType represents a log field with an error value.
	ErrorLogFieldType
	// StringsLogFieldType represents a log field with an array of string values.
	StringsLogFieldType
	// IntegersLogFieldType represents a log field with an array of integer values.
	IntegersLogFieldType
	// FloatsLogFieldType represents a log field with an array of float values.
	FloatsLogFieldType
	// BoolsLogFieldType represents a log field with an array of boolean values.
	BoolsLogFieldType
	// ErrorsLogFieldType represents a log field with an array of error values.
	ErrorsLogFieldType
)

const (
	// PreciseLinkStatusUnknown is used when we can't
	// determine an accurate status for a link.
	PreciseLinkStatusUnknown PreciseLinkStatus = iota
	// PreciseLinkStatusUpdatingResourceA is used when
	// the configuration for a link is being applied to resource A
	// in the link.
	PreciseLinkStatusUpdatingResourceA
	// PreciseLinkStatusResourceAUpdated is used when
	// the configuration for a link has been applied to resource A
	// in the link.
	PreciseLinkStatusResourceAUpdated
	// PreciseLinkStatusResourceAUpdateFailed is used when
	// the configuration for a link has failed to be applied to resource A
	// in the link.
	PreciseLinkStatusResourceAUpdateFailed
	// PreciseLinkStatusResourceAUpdateRollingBack is used when
	// another change in the same blueprint has failed
	// and the current link for which resource A was successfully
	// updated is being rolled back.
	PreciseLinkStatusResourceAUpdateRollingBack
	// PreciseLinkStatusResourceAUpdateRollbackFailed is used when
	// another change in the same blueprint has failed
	// and the current link for which resource A was successfully
	// updated failed to be rolled back.
	PreciseLinkStatusResourceAUpdateRollbackFailed
	// PreciseLinkStatusResourceAUpdateRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the current link for which resource A was succsefully updated
	// has been rolled back.
	PreciseLinkStatusResourceAUpdateRollbackComplete
	// PreciseLinkStatusUpdatingResourceB is used when
	// the configuration for a link is being applied to resource B
	// in the link.
	PreciseLinkStatusUpdatingResourceB
	// PreciseLinkStatusResourceBUpdated is used when
	// the configuration for a link has been applied to resource B
	// in the link.
	PreciseLinkStatusResourceBUpdated
	// PreciseLinkStatusResourceBUpdateFailed is used when
	// the configuration for a link has failed to be applied to resource B
	// in the link.
	PreciseLinkStatusResourceBUpdateFailed
	// PreciseLinkStatusResourceBUpdateRollingBack is used when
	// another change in the same blueprint has failed
	// and the current link for which resource B was successfully
	// updated is being rolled back.
	PreciseLinkStatusResourceBUpdateRollingBack
	// PreciseLinkStatusResourceBUpdateRollbackFailed is used when
	// another change in the same blueprint has failed
	// and the current link for which resource B was successfully
	// updated failed to be rolled back.
	PreciseLinkStatusResourceBUpdateRollbackFailed
	// PreciseLinkStatusResourceBUpdateRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the current link for which resource B was succsefully updated
	// has been rolled back.
	PreciseLinkStatusResourceBUpdateRollbackComplete
	// PreciseLinkStatusUpdatingIntermediaryResources is used when
	// intermediary resources are being created, updated or destroyed.
	// This status is a high level indication of progress,
	// the status of each intermediary resource should be checked
	// to determine the exact state of each intermediary resource
	// in the link.
	PreciseLinkStatusUpdatingIntermediaryResources
	// PreciseLinkStatusIntermediaryResourcesUpdated is used when
	// all intermediary resources have been successfully updated,
	// created or destroyed.
	PreciseLinkStatusIntermediaryResourcesUpdated
	// PreciseLinkStatusIntermediaryResourceUpdateFailed is used when
	// an intermediary resource has failed to be updated, created or destroyed.
	PreciseLinkStatusIntermediaryResourceUpdateFailed
	// PreciseLinkStatusIntermediaryResourceUpdateRollingBack is used when
	// another change in the same blueprint has failed
	// and the current link for which intermediary resources were successfully
	// updated is being rolled back.
	PreciseLinkStatusIntermediaryResourceUpdateRollingBack
	// PreciseLinkStatusIntermediaryResourceUpdateRollbackFailed is used when
	// another change in the same blueprint has failed
	// and the current link for which intermediary resources were successfully
	// updated failed to be rolled back.
	PreciseLinkStatusIntermediaryResourceUpdateRollbackFailed
	// PreciseLinkStatusIntermediaryResourceUpdateRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the current link for which intermediary resources were succsefully updated
	// has been rolled back.
	PreciseLinkStatusIntermediaryResourceUpdateRollbackComplete
	// PreciseLinkStatusResourceAUpdateInterrupted is used when
	// the resource A update for a link was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state is unknown and needs reconciliation.
	PreciseLinkStatusResourceAUpdateInterrupted
	// PreciseLinkStatusResourceBUpdateInterrupted is used when
	// the resource B update for a link was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state is unknown and needs reconciliation.
	PreciseLinkStatusResourceBUpdateInterrupted
	// PreciseLinkStatusIntermediaryResourceUpdateInterrupted is used when
	// the intermediary resources update for a link was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state is unknown and needs reconciliation.
	PreciseLinkStatusIntermediaryResourceUpdateInterrupted
)

const (
	// PreciseResourceStatusUnknown is used when we can't
	// determine an accurate status for a resource.
	PreciseResourceStatusUnknown PreciseResourceStatus = iota
	// PreciseResourceStatusCreating is used when
	// an initial resource deployment is currently in progress.
	PreciseResourceStatusCreating
	// PreciseResourceStatusConfigComplete is used when
	// a resource has been configured successfully.
	// What this means is that the resource has been created
	// but is not yet in a stable state.
	// For example, an application in a container orchestration service
	// has been created but is not yet up and running.
	PreciseResourceStatusConfigComplete
	// ResourceStatusCreated is used when
	// a resource has been deployed
	// successfully.
	// This is used when a resource is in a stable state.
	PreciseResourceStatusCreated
	// ResourceStatusCreateFailed is used when
	// the first creation of a resource failed.
	PreciseResourceStatusCreateFailed
	// PreciseResourceStatusCreateRollingBack is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// created is being rolled back.
	PreciseResourceStatusCreateRollingBack
	// PreciseResourceStatusCreateRollbackFailed is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// created could not be rolled back.
	PreciseResourceStatusCreateRollbackFailed
	// PreciseResourceStatusCreateRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// created has been rolled back.
	PreciseResourceStatusCreateRollbackComplete
	// ResourceStatusDestroying is used when
	// a resource is in the process of being destroyed.
	PreciseResourceStatusDestroying
	// ResourceStatusDestroyed is used when
	// a resource has been destroyed.
	PreciseResourceStatusDestroyed
	// ResourceStatusDestroyFailed is used when
	// the destruction of a resource fails.
	PreciseResourceStatusDestroyFailed
	// PreciseResourceStatusDestroyRollingBack is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// removed is being rolled back.
	// This involves recreating the resource from the previous state.
	PreciseResourceStatusDestroyRollingBack
	// PreciseResourceStatusDestroyRollbackFailed is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// removed could not be rolled back (recreated).
	PreciseResourceStatusDestroyRollbackFailed
	// PreciseResourceStatusDestroyRollbackConfigComplete is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// removed has been rolled back (recreated)
	// but is not yet in a stable state.
	PreciseResourceStatusDestroyRollbackConfigComplete
	// PreciseResourceStatusDestroyRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// removed has been rolled back (recreated).
	PreciseResourceStatusDestroyRollbackComplete
	// ResourceStatusUpdating is used when
	// a resource is being updated.
	PreciseResourceStatusUpdating
	// PreciseResourceStatusUpdateConfigComplete is used when
	// a resource being updated has been configured successfully.
	// What this means is that the resource has been updated
	// but is not yet in a stable state.
	// For example, an application in a container orchestration service
	// has been updated but the new version is not yet up and running.
	PreciseResourceStatusUpdateConfigComplete
	// ResourceStatusUpdated is used when a resource
	// has been sucessfully updated.
	PreciseResourceStatusUpdated
	// ResourceStatusUpdateFailed is used when a resource
	// has failed to update.
	PreciseResourceStatusUpdateFailed
	// PreciseResourceStatusUpdateRollingBack is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// updated is being rolled back to the previous state.
	PreciseResourceStatusUpdateRollingBack
	// PreciseResourceStatusUpdateRollbackFailed is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// updated could not be rolled back.
	PreciseResourceStatusUpdateRollbackFailed
	// PreciseResourceStatusUpdateRollbackConfigComplete is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// updated has been rolled back to the previous state
	// but is not yet in a stable state.
	PreciseResourceStatusUpdateRollbackConfigComplete
	// PreciseResourceStatusUpdateRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the current resource that was successfully
	// updated has been rolled back to the previous state.
	PreciseResourceStatusUpdateRollbackComplete
	// PreciseResourceStatusCreateInterrupted is used when
	// a resource creation was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	PreciseResourceStatusCreateInterrupted
	// PreciseResourceStatusUpdateInterrupted is used when
	// a resource update was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	PreciseResourceStatusUpdateInterrupted
	// PreciseResourceStatusDestroyInterrupted is used when
	// a resource destruction was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	PreciseResourceStatusDestroyInterrupted
)

const (
	// ResourceStatusUnknown is used when we can't
	// determine an accurate status for a resource.
	ResourceStatusUnknown ResourceStatus = iota
	// ResourceStatusCreating is used when
	// an initial resource deployment is currently in progress.
	ResourceStatusCreating
	// ResourceStatusCreated is used when
	// a resource has been deployed
	// successfully.
	ResourceStatusCreated
	// ResourceStatusCreateFailed is used when
	// the first creation of a resource failed.
	ResourceStatusCreateFailed
	// ResourceStatusDestroying is used when
	// a resource is in the process of being destroyed.
	ResourceStatusDestroying
	// ResourceStatusDestroyed is used when
	// a resource has been destroyed.
	ResourceStatusDestroyed
	// ResourceStatusDestroyFailed is used when
	// the destruction of a resource fails.
	ResourceStatusDestroyFailed
	// ResourceStatusUpdating is used when
	// a resource is being updated.
	ResourceStatusUpdating
	// ResourceStatusUpdated is used when a resource
	// has been successfully updated.
	ResourceStatusUpdated
	// ResourceStatusUpdateFailed is used when a resource
	// has failed to update.
	ResourceStatusUpdateFailed
	// ResourceStatusRollingBack is used when
	// another change in the same blueprint has failed
	// and the latest change involving the current resource
	// is being rolled back.
	ResourceStatusRollingBack
	// ResourceStatusRollbackFailed is used when
	// another change in the same blueprint has failed
	// and the latest change involving the current resource
	// could not be rolled back.
	ResourceStatusRollbackFailed
	// ResourceStatusRollbackComplete is used when
	// another change in the same blueprint has failed
	// and the latest change involving the current resource
	// has been rolled back.
	ResourceStatusRollbackComplete
	// ResourceStatusCreateInterrupted is used when
	// a resource creation was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	ResourceStatusCreateInterrupted
	// ResourceStatusUpdateInterrupted is used when
	// a resource update was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	ResourceStatusUpdateInterrupted
	// ResourceStatusDestroyInterrupted is used when
	// a resource destruction was interrupted due to deployment
	// being cancelled (e.g., drain timeout after terminal failure).
	// The actual state of the resource is unknown and needs reconciliation.
	ResourceStatusDestroyInterrupted
)

const (
	// ScalarTypeString is the type of an element in a spec that is a string.
	ScalarTypeString ScalarType = "string"
	// ScalarTypeInteger is the type of an element in a spec that is an integer.
	ScalarTypeInteger ScalarType = "integer"
	// ScalarTypeFloat is the type of an element in a spec that is a float.
	ScalarTypeFloat ScalarType = "float"
	// ScalarTypeBool is the type of an element in a spec that is a boolean.
	ScalarTypeBool ScalarType = "boolean"
	// ScalarTypeBytes is the type of a runtime-only element that is a byte array.
	// This type will NEVER appear in blueprint specifications and is only used
	// during substitution resolution to pass binary data between functions.
	// When serialized, bytes are always converted to UTF-8 strings.
	ScalarTypeBytes ScalarType = "bytes"
)