Class CommonTypesDef.Error.Builder
java.lang.Object
com.caplin.generated.motif.common.CommonTypesDef.Error.Builder
- Enclosing class:
- CommonTypesDef.Error
-
Method Summary
Modifier and TypeMethodDescription@NotNull CommonTypesDef.Error.Builder
@NotNull CommonTypesDef.Error
build()
@NotNull CommonTypesDef.Error.Builder
setErrorCode
(@NotNull String errorCode) @NotNull CommonTypesDef.Error.Builder
setErrorMessage
(@NotNull String errorMessage) @NotNull String
toString()
-
Method Details
-
addField
@NotNull public @NotNull CommonTypesDef.Error.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value) -
build
-
toString
-
setErrorCode
@NotNull public @NotNull CommonTypesDef.Error.Builder setErrorCode(@NotNull @NotNull String errorCode) - Parameters:
errorCode
- e.g. rfs.stream.expired- Returns:
- An error code that should be mapped to a description in their display language in the end user application
-
setErrorMessage
@NotNull public @NotNull CommonTypesDef.Error.Builder setErrorMessage(@NotNull @NotNull String errorMessage) - Parameters:
errorMessage
- e.g. Stream time of 120 second exceeded- Returns:
- Additional information about the error. This information is not translatable and is typically not shown to the end user, being provided primarily for traceability. Note that this information will appear in client logs.
-