Package markets.alpaca.client.ws.model

Record Class NewsArticle

java.lang.Object
java.lang.Record
markets.alpaca.client.ws.model.NewsArticle
Record Components:
id - unique news article ID
headline - headline or title of the article
summary - summary text (may be the first sentence of the content)
author - original author
createdAt - publication timestamp (RFC-3339)
updatedAt - last update timestamp (RFC-3339)
url - URL of the article (may be null)
content - full article content, may contain HTML (may be null)
symbols - related stock or crypto symbols
source - news source identifier (e.g. "benzinga")
public record NewsArticle(long id, String headline, String summary, String author, String createdAt, String updatedAt, String url, String content, List<String> symbols, String source) extends Record
A real-time news article event (T: "n").

  • Constructor Details

    • NewsArticle

      public NewsArticle(long id, String headline, String summary, String author, String createdAt, String updatedAt, String url, String content, List<String> symbols, String source)
      Creates an instance of a NewsArticle record class.
      Parameters:
      id - the value for the id record component
      headline - the value for the headline record component
      summary - the value for the summary record component
      author - the value for the author record component
      createdAt - the value for the createdAt record component
      updatedAt - the value for the updatedAt record component
      url - the value for the url record component
      content - the value for the content record component
      symbols - the value for the symbols record component
      source - the value for the source record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      @SerializedName("id") public long id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • headline

      @SerializedName("headline") public String headline()
      Returns the value of the headline record component.
      Returns:
      the value of the headline record component

    • summary

      @SerializedName("summary") public String summary()
      Returns the value of the summary record component.
      Returns:
      the value of the summary record component

    • author

      @SerializedName("author") public String author()
      Returns the value of the author record component.
      Returns:
      the value of the author record component

    • createdAt

      @SerializedName("created_at") public String createdAt()
      Returns the value of the createdAt record component.
      Returns:
      the value of the createdAt record component

    • updatedAt

      @SerializedName("updated_at") public String updatedAt()
      Returns the value of the updatedAt record component.
      Returns:
      the value of the updatedAt record component

    • url

      @SerializedName("url") public String url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component

    • content

      @SerializedName("content") public String content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component

    • symbols

      @SerializedName("symbols") public List<String> symbols()
      Returns the value of the symbols record component.
      Returns:
      the value of the symbols record component

    • source

      @SerializedName("source") public String source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component