Class CommonTypesDef.Error

    • Method Detail

      • getErrorCode

        @Nullable
        public @Nullable java.lang.String getErrorCode()
        Returns:
        An error code that should be mapped to a description in their display language in the end user application
      • getErrorMessage

        @Nullable
        public @Nullable java.lang.String getErrorMessage()
        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.
      • getFields

        @NotNull
        public @NotNull java.util.Map<java.lang.String,​java.lang.String> getFields()
        Specified by:
        getFields in interface Message
      • getFieldFlags

        @NotNull
        public @NotNull java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> getFieldFlags()
        Specified by:
        getFieldFlags in interface BuilderMessage
        Returns:
        Get the flags for all fields.
      • getFlagFields

        @NotNull
        public @NotNull java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> getFlagFields()
        Specified by:
        getFlagFields in interface BuilderMessage
        Returns:
        Get the fields for all flags.
      • toString

        @NotNull
        public @NotNull java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • from

        @NotNull
        public static @NotNull CommonTypesDef.Error from​(@NotNull
                                                         @NotNull java.util.Map<java.lang.String,​java.lang.String> fields)
      • from

        @NotNull
        public static @NotNull CommonTypesDef.Error from​(@NotNull
                                                         @NotNull java.util.Map<java.lang.String,​java.lang.String> fields,
                                                         @NotNull
                                                         @NotNull java.lang.String fieldPrefix)