Constructor Detail

Method Detail

• cashAmount

   final StockRetrieveDividendsResponse.Builder cashAmount(Double cashAmount)

  Cash amount of the dividend per share owned.

• cashAmount

   final StockRetrieveDividendsResponse.Builder cashAmount(JsonField<Double> cashAmount)

  Sets Builder.cashAmount to an arbitrary JSON value.

  You should usually call Builder.cashAmount with a well-typed Double value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• currency

   final StockRetrieveDividendsResponse.Builder currency(String currency)

  Currency in which the dividend is paid.

• currency

   final StockRetrieveDividendsResponse.Builder currency(JsonField<String> currency)

  Sets Builder.currency to an arbitrary JSON value.

  You should usually call Builder.currency with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• declarationDate

   final StockRetrieveDividendsResponse.Builder declarationDate(LocalDate declarationDate)

  Date on which the dividend was announced. In ISO 8601 format, YYYY-MM-DD.

• declarationDate

   final StockRetrieveDividendsResponse.Builder declarationDate(JsonField<LocalDate> declarationDate)

  Sets Builder.declarationDate to an arbitrary JSON value.

  You should usually call Builder.declarationDate with a well-typed LocalDate value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• dividendType

   final StockRetrieveDividendsResponse.Builder dividendType(String dividendType)

  Type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. Long-term and short-term capital gain distributions are denoted as LT and ST, respectively.

• dividendType

   final StockRetrieveDividendsResponse.Builder dividendType(JsonField<String> dividendType)

  Sets Builder.dividendType to an arbitrary JSON value.

  You should usually call Builder.dividendType with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• exDividendDate

   final StockRetrieveDividendsResponse.Builder exDividendDate(LocalDate exDividendDate)

  Date on or after which a Stock is traded without the right to receive the next dividend payment. If you purchase a Stock on or after the ex-dividend date, you will not receive the upcoming dividend. In ISO 8601 format, YYYY-MM-DD.

• exDividendDate

   final StockRetrieveDividendsResponse.Builder exDividendDate(JsonField<LocalDate> exDividendDate)

  Sets Builder.exDividendDate to an arbitrary JSON value.

  You should usually call Builder.exDividendDate with a well-typed LocalDate value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• frequency

   final StockRetrieveDividendsResponse.Builder frequency(Long frequency)

  Frequency of the dividend. The following values are possible:

  • 1 - Annual

  • 2 - Semi-Annual

  • 4 - Quarterly

  • 12 - Monthly

  • 52 - Weekly

  • 365 - Daily

• frequency

   final StockRetrieveDividendsResponse.Builder frequency(JsonField<Long> frequency)

  Sets Builder.frequency to an arbitrary JSON value.

  You should usually call Builder.frequency with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• payDate

   final StockRetrieveDividendsResponse.Builder payDate(LocalDate payDate)

  Date on which the dividend is paid out. In ISO 8601 format, YYYY-MM-DD.

• payDate

   final StockRetrieveDividendsResponse.Builder payDate(JsonField<LocalDate> payDate)

  Sets Builder.payDate to an arbitrary JSON value.

  You should usually call Builder.payDate with a well-typed LocalDate value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• recordDate

   final StockRetrieveDividendsResponse.Builder recordDate(LocalDate recordDate)

  Date that the shares must be held to receive the dividend; set by the company. In ISO 8601 format, YYYY-MM-DD.

• recordDate

   final StockRetrieveDividendsResponse.Builder recordDate(JsonField<LocalDate> recordDate)

  Sets Builder.recordDate to an arbitrary JSON value.

  You should usually call Builder.recordDate with a well-typed LocalDate value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• ticker

   final StockRetrieveDividendsResponse.Builder ticker(String ticker)

  Ticker symbol of the Stock.

• ticker

   final StockRetrieveDividendsResponse.Builder ticker(JsonField<String> ticker)

  Sets Builder.ticker to an arbitrary JSON value.

  You should usually call Builder.ticker with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final StockRetrieveDividendsResponse.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final StockRetrieveDividendsResponse.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final StockRetrieveDividendsResponse.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final StockRetrieveDividendsResponse.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final StockRetrieveDividendsResponse.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final StockRetrieveDividendsResponse build()

  Returns an immutable instance of StockRetrieveDividendsResponse.

  Further updates to this Builder will not mutate the returned instance.