Types

Topics covered in this chapter:

The dmpcompinst type

The dmpcompinst type contains metadata about a DMP component instance - ie a copy of a component in a specific lifecycle stage. This is intended for advanced users; the attributes of this type correspond directly to the values returned from the 'componentinstances' endpoint in the DMP Manager webservices and users should consult DMP Manager documentation to understand how to use them.

dmpcompinst  : type

componentid  : text
id  : text
name  : text
description  : text
url  : text
internalurl  : text
proxyurl  : text
healthcheckrelativeurl  : text
enginetype  : text
engineprofile  : text
engineversion  : text
scalecount  : int
parentinstanceid  : text
systemdata  : text
containerproviderdata  : text
containerproviderid  : text
containerserviceproviderid  : text
env  : string
envid  : text
rowversion  : int
createdby  : text
createdts  : text
lastmodifiedby  : text
lastmodifiedts  : text
state  : string
statedescription  : text
alternateinstance  : bool
multidatacenterinstance  : bool
currentrevision  : dmpcomprev

The dmpcompinstrev type

The dmpcompinstrev type contains metadata about a revision of a DMP component instance. This is intended for advanced users; the attributes of this type correspond directly to the values returned in the revision structure from the 'componentinstances' endpoint in the DMP Manager webservices and users should consult DMP Manager documentation to understand how to use them.

dmpcompinstrev  : type

id  : text
label  : text
version  : text
createdts  : text
createdby  : text
comment  : text
componentinstanceid  : text
componentprototyperevisionid  : text
componentrevisionid  : text
fromcomponentinstancerevisionid  : text
state  : string
lcmstate  : string
lcmstatedescription  : text

The dmpcomponent type

The dmpcomponent type contains metadata about a DMP component - the component ID, name, type and the lifecycle environments in which it's available. A dmpcomponent contains no authorization token and cannot be used to communicate with the component directly but can be passed to dmpinitcomp to initialize a dmpresource.

dmpcomponent  : type

id  : text
	The component ID; note this is different from the component instance ID.
name  : text
	The component name.
type  : text
	The component type, e.g. "FICO Xpress Executor".
envs  : set of string
	The DMP lifecycle stages in which instances of this component are available; represented by the following constants: Values DMP_ENV_DESIGN Design or Root DMP_ENV_STAGING Staging DMP_ENV_PRODUCTION Production
instances  : list of dmpcompinst
	A list with one entry for each instance of the component.

The dmpresource type

The dmpresource type represents a URL and associated authorization credentials. For example, the dmpresource initialized by dmpinitcomp will contain the URL of the component as well as an appropriate bearer token for authorizing requests. The URL and some other attributes can be read, but the authorization token may not. Other than "abspath", all the attributes of the dmpresource type are read-only and cannot be set directly.

dmpresource  : type

resourcetype  : integer
	The resource type referred to by the object-the value will correspond to one of the constants listed here: Values DMP_RESOURCE_DMP_MANAGER DMP Manager DMP_RESOURCE_COMPONENT Component DMP_RESOURCE_WEBSERVICE Web service DMP_RESOURCE_DATA_PIPELINES Data Pipelines service DMP_RESOURCE_USER User-specified URL DMP_RESOURCE_UNINITIALIZED Uninitialized
url  : text
	The root URL of the DMP resource.
id  : text
	For component resources, this is the component ID. For webservice resources, this is the solution service instance ID. For Data Pipelines resources, this is the solution service ID. For other resource types, this is unset.
name  : text
	For component resources, this is the component name. For webservice resources, this is the function name. For Data Pipelines resources, this is the solution service name. For other resource types, this is unset.
type  : text
	For component resources, this is the component type, e.g. "FICO Xpress Insight". For webservice resources, this is the constant string "SERVERLESS_REST". For Data Pipelines resources, this is the constant string "DataPipelines". For other resource types, this is unset.
env  : string
	The DMP lifecycle stage of the resource being referenced; an empty string when not relevent, otherwise one of the following constants: Values DMP_ENV_DESIGN Design or Root DMP_ENV_STAGING Staging DMP_ENV_PRODUCTION Production
abspath  : boolean
	Flag indicating whether request paths are treated as absolute when they start with the same path as the DMP component's URL, as described in section Absolute Request Paths. Defaults to true.
status  : integer
	The status of the last dmpinit operation called on this dmpresource. One of the following constants: Values DMP_OK Success DMP_ACCESS_DENIED Resource found but you do not have access to it DMP_NOT_FOUND Resource not found DMP_IO_ERROR Internal error reading or writing data DMP_PARSE_ERROR Internal error parsing data DMP_AUTH_ERROR Error fetching authorization credentials from function
context  : any
	A value that can be saved to identify this dmpresource or attach additional data. The context value is not used by the dmp module directly, but may be to make additional data available to the function that supplies authorization headers.
lasterror  : text
	The error message generated by the last dmpinit operation on this dmpresource, if it failed.