Package markets.alpaca.client.openapi.data.model

Class NewsImage

java.lang.Object
markets.alpaca.client.openapi.data.model.NewsImage
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class NewsImage extends Object implements Serializable
A model representing images for a news article. Simply a URL to the image along with a size parameter suggesting the display size of the image.
See Also:

  • Field Details

  • Constructor Details

    • NewsImage

      public NewsImage()

  • Method Details

    • size

      public NewsImage size(@Nonnull NewsImage.SizeEnum size)

    • getSize

      @Nonnull public NewsImage.SizeEnum getSize()
      Possible values for size are thumb, small and large.
      Returns:
      size

    • setSize

      public void setSize(@Nonnull NewsImage.SizeEnum size)

    • url

      public NewsImage url(@Nonnull URI url)

    • getUrl

      @Nonnull public URI getUrl()
      URL to image from news article.
      Returns:
      url

    • setUrl

      public void setUrl(@Nonnull URI url)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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