Note: There is a newer version (1.0.1) of this package available. Click here to view docs for the latest version.
Module icp.runtime.bridge
wso2/icp.runtime.bridge
0.2.0
Package Overview
The icp.runtime.bridge library is one of the external library packages, it provides internal support for exposing
Ballerina runtime artifacts to the integration control plane.
Report Issues
To report bugs, request new features, start new discussions, view project boards, etc., go to the WSO2 Integrator repository
Useful Links
- Chat live with us via our Discord server.
- Post all technical questions on Stack Overflow with the #ballerina tag.
Functions
loadConfig
Classes
icp.runtime.bridge: HeartbeatJob
execute
function execute()Executes the heartbeat job.
Clients
icp.runtime.bridge: IcpClient
ICP Client This client is responsible for communicating with the ICP server to send heartbeats and receive control commands
sendDeltaHeartbeat
Isolated FunctionRemote Function
function sendDeltaHeartbeat(DeltaHeartbeat deltaHeartbeat) returns HeartbeatResponse|errorParameters
- deltaHeartbeat DeltaHeartbeat -
sendHeartbeat
Isolated FunctionRemote Function
function sendHeartbeat(Heartbeat heartbeat) returns HeartbeatResponse|errorParameters
- heartbeat Heartbeat -
Enums
icp.runtime.bridge: ArtifactState
Members
ENABLED
DISABLED
icp.runtime.bridge: ArtifactType
Members
SERVICE
LISTENER
icp.runtime.bridge: ControlAction
Members
START
STOP
SET_LOGGER_LEVEL
icp.runtime.bridge: ControlCommandStatus
Members
PENDING
SENT
ACKNOWLEDGED
FAILED
COMPLETED
icp.runtime.bridge: RuntimeStatus
Members
RUNNING
OFFLINE
icp.runtime.bridge: RuntimeType
Members
BI
Configurables
icp.runtime.bridge: runtimeIdFile
icp.runtime.bridge: serverUrl
icp.runtime.bridge: heartbeatInterval
icp.runtime.bridge: cert
icp.runtime.bridge: enableSSL
icp.runtime.bridge: jwtIssuer
icp.runtime.bridge: jwtExpiryTimeSeconds
icp.runtime.bridge: runtime
icp.runtime.bridge: environment
icp.runtime.bridge: integration
icp.runtime.bridge: project
icp.runtime.bridge: secret
icp.runtime.bridge: enableWorkflowManagement
icp.runtime.bridge: runtimeHostUrl
icp.runtime.bridge: workflowManagementApiPort
Records
icp.runtime.bridge: Artifact
Fields
- name string -
icp.runtime.bridge: Artifacts
Fields
- listeners? ListenerDetail[] -
- services? ServiceDetail[] -
- main? MainDetail -
icp.runtime.bridge: ControlCommand
Fields
- commandId string -
- runtimeId string -
- targetArtifact Artifact -
- action ControlAction -
- issuedAt Utc -
- status ControlCommandStatus -
- payload? string -
icp.runtime.bridge: DeltaHeartbeat
Closed record
Fields
- runtimeId string -
- heartbeatVersion string(default HEARTBEAT_VERSION) -
- runtimeHash string -
- timestamp Utc -
icp.runtime.bridge: Heartbeat
Closed record
Fields
- runtimeId string -
- runtime? string -
- runtimeType RuntimeType -
- heartbeatVersion string(default HEARTBEAT_VERSION) -
- status RuntimeStatus -
- environment string(default environment) -
- project string -
- component string -
- version? string -
- nodeInfo Node -
- artifacts Artifacts -
- runtimeHash string -
- timestamp Utc -
- workflowCallbackUrl? string -
- tryItHost? string -
- openApiDefinitions? map<json> -
icp.runtime.bridge: HeartbeatForHash
Closed record
Fields
- runtimeId string -
- runtime? string -
- runtimeType RuntimeType -
- heartbeatVersion string(default HEARTBEAT_VERSION) -
- status RuntimeStatus -
- environment string -
- project string -
- component string -
- version? string -
- nodeInfo Node -
- artifacts Artifacts -
- workflowCallbackUrl? string -
- tryItHost? string -
icp.runtime.bridge: HeartbeatResponse
Fields
- acknowledged boolean -
- fullHeartbeatRequired? boolean -
- commands ControlCommand[](default []) -
- supportedHeartbeatFields? string[] -
icp.runtime.bridge: IcpConfig
Closed record
Fields
- serverUrl string -
- cert string -
- enableSSL boolean -
- heartbeatInterval int -
icp.runtime.bridge: ListenerDetail
Fields
- Fields Included from *Artifact
- name string
- anydata...
- protocol? string -
- package string -
- state ArtifactState(default "enabled") -
icp.runtime.bridge: LoggerLevelPayload
Closed record
Fields
- componentName string -
- componentPackage? string -
- logLevel Level -
icp.runtime.bridge: MainDetail
Fields
- packageOrg string -
- packageName string -
- packageVersion string -
icp.runtime.bridge: Node
Fields
- platformName string(default "ballerina") -
- platformVersion? string -
- platformHome? string -
- ballerinaHome? string -
- osName? string -
- osVersion? string -
icp.runtime.bridge: RequestLimit
Fields
- maxUriLength int -
- maxHeaderSize int -
- maxEntityBodySize int -
icp.runtime.bridge: Resource
Fields
- methods string[] -
- url string -
icp.runtime.bridge: ServiceDetail
Fields
- Fields Included from *Artifact
- name string
- anydata...
- basePath string? -
- package string -
- listeners Artifact[] -
- resources Resource[] -
- state ArtifactState(default "enabled") -
Union types
icp.runtime.bridge: ArtifactDetail
ArtifactDetail