Package org.springframework.cloud.servicebroker.model.error

Class ErrorMessage

java.lang.Object
org.springframework.cloud.servicebroker.model.error.ErrorMessage
All Implemented Interfaces:
Serializable
public class ErrorMessage extends Object implements Serializable
Details of an error reported to the platform from a service broker.
Author:
S Greenberg, Scott Frederick, Roy Clarkson
See Also:

  • Constructor Details

    • ErrorMessage

      public ErrorMessage()
      Construct an error message with no error code or description.

    • ErrorMessage

      public ErrorMessage(String message)
      Construct an error message with the provided description.
      Parameters:
      message - a user-facing error message explaining why the request failed

    • ErrorMessage

      public ErrorMessage(String error, String message)
      Construct an error message with the provided error code and description.
      Parameters:
      error - a single word in camel case that uniquely identifies the error condition
      message - a user-facing error message explaining why the request failed

    • ErrorMessage

      public ErrorMessage(String error, String message, Boolean instanceUsable, Boolean updateRepeatable)
      Construct an error message.
      Parameters:
      error - a single word in camel case that uniquely identifies the error condition
      message - a user-facing error message explaining why the request failed
      instanceUsable - is the instance still usable after a failed operation
      updateRepeatable - can the update be repeated after a failed operation

  • Method Details

    • getError

      public String getError()
      Get the error code.
      Returns:
      the error code

    • getMessage

      public String getMessage()
      Get the description.
      Returns:
      the description.

    • isInstanceUsable

      public Boolean isInstanceUsable()
      Get a boolean value indicating whether the instance is usable after a failed update or deprovisioning operation.
      Returns:
      the boolean value

    • isUpdateRepeatable

      public Boolean isUpdateRepeatable()
      Get a boolean value indicating whether a failed update is repeatable.
      Returns:
      the boolean value

    • builder

      public static ErrorMessage.ErrorMessageBuilder builder()
      Create a builder that provides a fluent API for constructing an ErrorMessage.
      Returns:
      the builder

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public final String toString()
      Overrides:
      toString in class Object