Class BaseResponse

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.String> getMsg()
      returns the message of the error encountered.
      java.util.Optional<java.lang.String> getOperationID()
      returns a unique ID generated to identify a specific operation.
      APIStatus getStatus()
      returns the status of the operation.
      java.util.Optional<java.lang.String> getType()
      returns the type of error encountered.
      java.util.Optional<UserInput[]> getUserInputs()
      returns the UserInputs required for this operation, which are the further information required from the user before the job can be completed.
      boolean isSuccess()
      returns true if request is successful and false otherwise.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getStatus

        public APIStatus getStatus()
        returns the status of the operation.
      • isSuccess

        public boolean isSuccess()
        returns true if request is successful and false otherwise.
      • getOperationID

        public java.util.Optional<java.lang.String> getOperationID()
        returns a unique ID generated to identify a specific operation.
      • getUserInputs

        public java.util.Optional<UserInput[]> getUserInputs()
        returns the UserInputs required for this operation, which are the further information required from the user before the job can be completed.
      • getType

        public java.util.Optional<java.lang.String> getType()
        returns the type of error encountered. only available if the operation was not successful.
      • getMsg

        public java.util.Optional<java.lang.String> getMsg()
        returns the message of the error encountered. only available if the operation was not successful.