Package com.sap.ai.sdk.grounding.model

Class ApiError

java.lang.Object
com.sap.ai.sdk.grounding.model.ApiError
public class ApiError extends Object
ApiError

  • Constructor Details

    • ApiError

      protected ApiError()
      Default constructor for ApiError.

  • Method Details

    • code

      @Nonnull public ApiError code(@Nonnull String code)
      Set the code of this ApiError instance and return the same instance.
      Parameters:
      code - Descriptive error code (not http status code).
      Returns:
      The same instance of this ApiError class

    • getCode

      @Nonnull public String getCode()
      Descriptive error code (not http status code).
      Returns:
      code The code of this ApiError instance.

    • setCode

      public void setCode(@Nonnull String code)
      Set the code of this ApiError instance.
      Parameters:
      code - Descriptive error code (not http status code).

    • message

      @Nonnull public ApiError message(@Nonnull String message)
      Set the message of this ApiError instance and return the same instance.
      Parameters:
      message - plaintext error description
      Returns:
      The same instance of this ApiError class

    • getMessage

      @Nonnull public String getMessage()
      plaintext error description
      Returns:
      message The message of this ApiError instance.

    • setMessage

      public void setMessage(@Nonnull String message)
      Set the message of this ApiError instance.
      Parameters:
      message - plaintext error description

    • requestId

      @Nonnull public ApiError requestId(@Nullable String requestId)
      Set the requestId of this ApiError instance and return the same instance.
      Parameters:
      requestId - id of individual request
      Returns:
      The same instance of this ApiError class

    • getRequestId

      @Nonnull public String getRequestId()
      id of individual request
      Returns:
      requestId The requestId of this ApiError instance.

    • setRequestId

      public void setRequestId(@Nullable String requestId)
      Set the requestId of this ApiError instance.
      Parameters:
      requestId - id of individual request

    • target

      @Nonnull public ApiError target(@Nullable String target)
      Set the target of this ApiError instance and return the same instance.
      Parameters:
      target - url that has been called
      Returns:
      The same instance of this ApiError class

    • getTarget

      @Nonnull public String getTarget()
      url that has been called
      Returns:
      target The target of this ApiError instance.

    • setTarget

      public void setTarget(@Nullable String target)
      Set the target of this ApiError instance.
      Parameters:
      target - url that has been called

    • details

      @Nonnull public ApiError details(@Nullable List<DetailsErrorResponse> details)
      Set the details of this ApiError instance and return the same instance.
      Parameters:
      details - The details of this ApiError
      Returns:
      The same instance of this ApiError class

    • addDetailsItem

      @Nonnull public ApiError addDetailsItem(@Nonnull DetailsErrorResponse detailsItem)
      Add one details instance to this ApiError.
      Parameters:
      detailsItem - The details that should be added
      Returns:
      The same instance of type ApiError

    • getDetails

      @Nonnull public List<DetailsErrorResponse> getDetails()
      Get details
      Returns:
      details The details of this ApiError instance.

    • setDetails

      public void setDetails(@Nullable List<DetailsErrorResponse> details)
      Set the details of this ApiError instance.
      Parameters:
      details - The details of this ApiError

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the ApiError.
      Returns:
      The set of properties names

    • getCustomField

      @Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException
      Deprecated.
      Use toMap() instead.
      Get the value of an unrecognizable property of this ApiError instance.
      Parameters:
      name - The name of the property
      Returns:
      The value of the property
      Throws:
      NoSuchElementException - If no property with the given name could be found.

    • toMap

      @Nonnull public Map<String,Object> toMap()
      Get the value of all properties of this ApiError instance including unrecognized properties.
      Returns:
      The map of all properties

    • setCustomField

      public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue)
      Set an unrecognizable property of this ApiError instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      customFieldName - The name of the property
      customFieldValue - The value of the property

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class Object

    • create

      public static ApiError.Builder create()
      Create a type-safe, fluent-api builder object to construct a new ApiError instance with all required arguments.