Package com.rubensgomes.base.reqresp

Class BaseResponse

java.lang.Object
com.rubensgomes.base.reqresp.BaseResponse
@Generated("jsonschema2pojo") public class BaseResponse extends Object
Base Response Object

A base type that should be part of all microservice responses.

  • Constructor Details

    • BaseResponse

      public BaseResponse()
      No args constructor for use in serialization

    • BaseResponse

      public BaseResponse(String clientId, String correlationId, BaseResponse.ResponseStatus responseStatus, List<Error> error)
      Parameters:
      clientId - The application client Id. Notice that this is not the ID of the consumer, but of actual client that initiated the system request.
      correlationId - A text to correlate the request across the system.
      responseStatus - The status of the response.
      error - The list of errors.

  • Method Details

    • builder

      public static BaseResponse.BaseResponseBuilderBase builder()

    • getClientId

      public String getClientId()
      The application client Id. Notice that this is not the ID of the consumer, but of actual client that initiated the system request. (Required)

    • setClientId

      public void setClientId(String clientId)
      The application client Id. Notice that this is not the ID of the consumer, but of actual client that initiated the system request. (Required)

    • getCorrelationId

      public String getCorrelationId()
      A text to correlate the request across the system. (Required)

    • setCorrelationId

      public void setCorrelationId(String correlationId)
      A text to correlate the request across the system. (Required)

    • getResponseStatus

      public BaseResponse.ResponseStatus getResponseStatus()
      The status of the response. (Required)

    • setResponseStatus

      public void setResponseStatus(BaseResponse.ResponseStatus responseStatus)
      The status of the response. (Required)

    • getError

      public List<Error> getError()
      The list of errors.

    • setError

      public void setError(List<Error> error)
      The list of errors.

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • setAdditionalProperty

      public void setAdditionalProperty(String name, Object value)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object