Package markets.alpaca.client.openapi.trading.model

Class ListLocatesResponse

java.lang.Object
markets.alpaca.client.openapi.trading.model.ListLocatesResponse
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ListLocatesResponse extends Object implements Serializable
Response to a successful request for a list of locates.
See Also:

  • Field Details

  • Constructor Details

    • ListLocatesResponse

      public ListLocatesResponse()

  • Method Details

    • locates

      public ListLocatesResponse locates(@Nonnull List<Locate> locates)

    • addLocatesItem

      public ListLocatesResponse addLocatesItem(Locate locatesItem)

    • getLocates

      @Nonnull public List<Locate> getLocates()
      Locates matching the filter criteria.
      Returns:
      locates

    • setLocates

      public void setLocates(@Nonnull List<Locate> locates)

    • nextPageToken

      public ListLocatesResponse nextPageToken(@Nullable String nextPageToken)

    • getNextPageToken

      @Nullable public String getNextPageToken()
      The token to use to retrieve the next page of results. If `null`, there are no more pages.
      Returns:
      nextPageToken

    • setNextPageToken

      public void setNextPageToken(@Nullable String nextPageToken)

    • putAdditionalProperty

      public ListLocatesResponse 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 ListLocatesResponse 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 ListLocatesResponse

    • fromJson

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

    • toJson

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