Package markets.alpaca.client.openapi.broker.model

Class DIVWHActivityV2

java.lang.Object
markets.alpaca.client.openapi.broker.model.DIVWHActivityV2
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class DIVWHActivityV2 extends Object implements Serializable
Dividend tax withholding (e.g. foreign withholding on global securities)
See Also:

  • Field Details

  • Constructor Details

    • DIVWHActivityV2

      public DIVWHActivityV2()

  • Method Details

    • groupId

      public DIVWHActivityV2 groupId(@Nullable UUID groupId)

    • getGroupId

      @Nullable public UUID getGroupId()
      Optional group ID which can help grouping together related activities
      Returns:
      groupId

    • setGroupId

      public void setGroupId(@Nullable UUID groupId)

    • systemDate

      public DIVWHActivityV2 systemDate(@Nonnull LocalDate systemDate)

    • getSystemDate

      @Nonnull public LocalDate getSystemDate()
      The date when the activity was booked
      Returns:
      systemDate

    • setSystemDate

      public void setSystemDate(@Nonnull LocalDate systemDate)

    • cusip

      public DIVWHActivityV2 cusip(@Nonnull String cusip)

    • getCusip

      @Nonnull public String getCusip()
      The CUSIP of the security involved with the activity
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • isin

      public DIVWHActivityV2 isin(@Nullable String isin)

    • getIsin

      @Nullable public String getIsin()
      The ISIN of the security involved with the activity
      Returns:
      isin

    • setIsin

      public void setIsin(@Nullable String isin)

    • parentId

      public DIVWHActivityV2 parentId(@Nonnull UUID parentId)

    • getParentId

      @Nonnull public UUID getParentId()
      The ref_id of the parent dividend
      Returns:
      parentId

    • setParentId

      public void setParentId(@Nonnull UUID parentId)

    • symbol

      public DIVWHActivityV2 symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      The symbol of the security involved with the activity
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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