Note: There is a newer version (0.1.2) of this package available. Click here to view docs for the latest version.
Module cp.resi
thushani/cp.resi
Deprecated0.1.0
Choreo control plane resilient invoker implementation. [//]: # (above is the package summary)
Package Overview
Choreo control plane resilient invoker implementation.
Enums
cp.resi: FailureReason
Reason for the Invocation failure.
Members
CONNECTION\-ERROR
RESPONSE\-ERROR
cp.resi: InvocationEvent
Types of events to notify.
Members
INVOCATION_ALL
INVOCATION_FAILED
INVOCATION_SUCCESSFUL
INVOCATION_TERMINATED
cp.resi: MediaType
Media Type.
Members
JSON
TEXT
XML
cp.resi: Outcome
Outcome of the invocation.
Members
SUCCESSFUL
FAILED
cp.resi: ScheduleStatus
Status of the invocation.
Members
IN\-PROGRESS
TERMINATED
COMPLETED
Configurables
cp.resi: healthCheckPort
cp.resi: queueName
cp.resi: timeToLive
cp.resi: asbConnectionStringPath
cp.resi: asbConnectionString
Records
cp.resi: ExecutionInfo
Closed record
Information about the execution.
Fields
- attempt int - Current attempt
- totalAttempts int - Total attempts
- startTimestamp int - Start time of the invocation
- duration decimal - Time taken for the invocation
- nextAttemptAt? int - Timestamp of the next scheduled invocation attempt
- scheduleStatus ScheduleStatus - Status of the invocation
cp.resi: FailureInfo
Closed record
Information about the Invocation failure.
Fields
- reason FailureReason - Reason for the failure
- message? string - Additional message about the failure
cp.resi: Header
Closed record
Header.
Fields
- name string - Header name
cp.resi: Invocation
Closed record
Invocation.
Fields
- target Target - Target to invoke in a resilient manner
- completeOn int[] - Expected status codes to complete the invocation
- retryConfig? RetryConfig - Retry configuration
- notificationConfig Notification[] - Notification configuration
- metaInfo? MetaInfo - Meta information about the invocation
- id string - Invocation Id
cp.resi: MetaInfo
Closed record
Meta Information.
Fields
- correlationId string - Correlation Id
- message? string - Message
cp.resi: Notification
Closed record
Notification Configuration.
Fields
- webhookUrl string - URL of the webhook
- events InvocationEvent[] - Events to notify
cp.resi: ResponsePayload
Closed record
Response payload.
Fields
- payload json|xml - Payload
- mediaType MediaType - Type of the payload
cp.resi: RetryConfig
Closed record
Retry Configuration.
Fields
- initialDelay int(default 1) - Initial Delay in seconds
- progressionFactor decimal(default 1.0) - The factor by which the delay between retry attempts progresses.
- maxDelay int(default 3600) - Maximum delay in seconds
- count int(default 150) - Maximum number of calls to make. By default this is set to 150.
cp.resi: Target
Closed record
Taget to invoke.
Fields
- targetUrl string - Target URL
- method string - HTTP Method
- headers? Header[] - Request headers
- targetPayload? TargetPayload - Target payload
cp.resi: TargetInvocationFailedNotification
Closed record
Notification about a failed invocation.
Fields
- invocationId string - Invocation Id
- execution int - Execution count
- failureInfo FailureInfo - Information about the failure
- response? TargetResponse - Response from the target
- executionInfo ExecutionInfo - Information about the invocation schedule
cp.resi: TargetInvocationNotification
Closed record
Common notification about the Invocation.
Fields
- invocationId string - Invocation Id
- execution int - Execution count
- outcome Outcome - Outcome of the invocation
- failureInfo? FailureInfo - Information about the Invocation failure
- response? TargetResponse - Response from the target
- executionInfo ExecutionInfo - Information about the invocation schedule
cp.resi: TargetInvocationSuccessfulNotification
Closed record
Notification about a successful invocation.
Fields
- invocationId string - Invocation Id
- execution int - Execution count
- response? TargetResponse - Response from the target
- executionInfo ExecutionInfo - Information about the invocation schedule
cp.resi: TargetPayload
Closed record
Target payload.
Fields
- payload json - Payload
- mediaType MediaType - Type of the payload
cp.resi: TargetResponse
Closed record
Response from the target.
Fields
- responseCode int - Response code
- responseBody? ResponsePayload - Response body
- responseHeaders? Header[] - Response headers