Class LocateError

java.lang.Object
markets.alpaca.client.openapi.trading.model.LocateError
All Implemented Interfaces:
Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class LocateError extends Object implements Serializable
Locates API error response. Locate-specific 400 and create locate 422 errors include a machine-readable `code`.
See Also:
  • Field Details

  • Constructor Details

    • LocateError

      public LocateError()
  • Method Details

    • code

      public LocateError code(@Nullable LocateError.CodeEnum code)
    • getCode

      @Nullable public LocateError.CodeEnum getCode()
      Machine-readable error code. Present on locate-specific 400 and create locate 422 errors.
      Returns:
      code
    • setCode

      public void setCode(@Nullable LocateError.CodeEnum code)
    • message

      public LocateError message(@Nonnull String message)
    • getMessage

      @Nonnull public String getMessage()
      Error message.
      Returns:
      message
    • setMessage

      public void setMessage(@Nonnull String message)
    • putAdditionalProperty

      public LocateError putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the LocateError instance itself
    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects
    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to LocateError
    • fromJson

      public static LocateError fromJson(String jsonString) throws IOException
      Create an instance of LocateError given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of LocateError
      Throws:
      IOException - if the JSON string is invalid with respect to LocateError
    • toJson

      public String toJson()
      Convert an instance of LocateError to an JSON string
      Returns:
      JSON string