Note: There is a newer version (0.3.0) of this package available. Click here to view docs for the latest version.
Module wso2.icp
ballerinax/wso2.icp Ballerina library
0.2.0
Package Overview
The wso2.icp 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 Ballerina standard library parent 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
wso2.icp: HeartbeatJob
execute
function execute()Executes the heartbeat job.
Clients
wso2.icp: 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
wso2.icp: ArtifactState
Members
ENABLED
DISABLED
wso2.icp: ArtifactType
Members
SERVICE
LISTENER
wso2.icp: ControlAction
Members
START
STOP
SET_LOGGER_LEVEL
wso2.icp: ControlCommandStatus
Members
PENDING
SENT
ACKNOWLEDGED
FAILED
COMPLETED
wso2.icp: RuntimeStatus
Members
RUNNING
OFFLINE
wso2.icp: RuntimeType
Members
MI
BI
Configurables
wso2.icp: runtimeIdFile
wso2.icp: serverUrl
wso2.icp: heartbeatInterval
wso2.icp: cert
wso2.icp: enableSSL
wso2.icp: jwtIssuer
wso2.icp: jwtExpiryTimeSeconds
wso2.icp: runtime
wso2.icp: environment
wso2.icp: integration
wso2.icp: project
wso2.icp: runtimeJwtHMACSecret
Records
wso2.icp: Artifact
Fields
- name string -
wso2.icp: Artifacts
Fields
- listeners? ListenerDetail[] -
- services? ServiceDetail[] -
- main? MainDetail -
wso2.icp: ControlCommand
Fields
- commandId string -
- runtimeId string -
- targetArtifact Artifact -
- action ControlAction -
- issuedAt Utc -
- status ControlCommandStatus -
- payload? string -
wso2.icp: DeltaHeartbeat
Closed record
Fields
- runtime string -
- runtimeHash string -
- timestamp Utc -
wso2.icp: Heartbeat
Closed record
Fields
- runtime string -
- runtimeType RuntimeType -
- status RuntimeStatus -
- environment string(default environment) -
- project string -
- component string -
- version? string -
- nodeInfo Node -
- artifacts Artifacts -
- runtimeHash string -
- timestamp Utc -
wso2.icp: HeartbeatForHash
Closed record
Fields
- runtime string -
- runtimeType RuntimeType -
- status RuntimeStatus -
- environment string -
- project string -
- component string -
- version? string -
- nodeInfo Node -
- artifacts Artifacts -
wso2.icp: HeartbeatResponse
Fields
- acknowledged boolean -
- fullHeartbeatRequired? boolean -
- commands ControlCommand[](default []) -
wso2.icp: IcpConfig
Closed record
Fields
- serverUrl string -
- cert string -
- enableSSL boolean -
- heartbeatInterval int -
wso2.icp: ListenerDetail
Fields
- Fields Included from *Artifact
- name string
- anydata...
- protocol? string -
- package string -
- state ArtifactState(default "enabled") -
wso2.icp: LoggerLevelPayload
Closed record
Fields
- componentName string -
- logLevel Level -
wso2.icp: MainDetail
Fields
- packageOrg string -
- packageName string -
- packageVersion string -
wso2.icp: Node
Fields
- platformName string(default "ballerina") -
- platformVersion? string -
- platformHome? string -
- ballerinaHome? string -
- osName? string -
- osVersion? string -
wso2.icp: RequestLimit
Fields
- maxUriLength int -
- maxHeaderSize int -
- maxEntityBodySize int -
wso2.icp: Resource
Fields
- methods string[] -
- url string -
wso2.icp: ServiceDetail
Fields
- Fields Included from *Artifact
- name string
- anydata...
- basePath string? -
- package string -
- listeners Artifact[] -
- resources Resource[] -
- state ArtifactState(default "enabled") -
Union types
wso2.icp: ArtifactDetail
ArtifactDetail