public final class IntegrationResponse
extends Object
success
, result
, and error
are returned to the user. Diagnostics are displayed to the user for debugging.
Modifier and Type | Class and Description |
---|---|
static class |
IntegrationResponse.Builder
Builder for the integration response
|
Modifier and Type | Method and Description |
---|---|
static IntegrationResponse.Builder |
forError(IntegrationError error)
A builder with success set to false
Diagnostics should still be added if
ExecutionContext.isDiagnosticsEnabled() |
static IntegrationResponse.Builder |
forSuccess(Map<String,Object> result)
A builder with success set to true
Diagnostics should still be added if
ExecutionContext.isDiagnosticsEnabled() |
IntegrationError |
getError()
The error that occurred during the call, if an error occurred
|
IntegrationDesignerDiagnostic |
getIntegrationDesignerDiagnostic()
Diagnostics for the execution
|
Map<String,Object> |
getResult()
The information retrieved from the external system that is relevant to the user
|
boolean |
isSuccess()
Whether the execution was successful
|
IntegrationResponse.Builder |
toBuilder()
Converts response to a builder, preserving field values
|
public static IntegrationResponse.Builder forSuccess(Map<String,Object> result)
Diagnostics should still be added if ExecutionContext.isDiagnosticsEnabled()
result
- The result of the integrationpublic static IntegrationResponse.Builder forError(IntegrationError error)
Diagnostics should still be added if ExecutionContext.isDiagnosticsEnabled()
error
- The IntegrationError
describing the failurepublic IntegrationResponse.Builder toBuilder()
public boolean isSuccess()
public Map<String,Object> getResult()
public IntegrationError getError()
public IntegrationDesignerDiagnostic getIntegrationDesignerDiagnostic()
Copyright © 2018-present Appian Corporation. All Rights Reserved.