Document AI V1beta3 API - Class Google::Type::Money (v0.43.1)

Reference documentation and code samples for the Document AI V1beta3 API class Google::Type::Money.

Represents an amount of money with its currency type.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#currency_code

def currency_code() -> ::String
Returns
  • (::String) — The three-letter currency code defined in ISO 4217.

#currency_code=

def currency_code=(value) -> ::String
Parameter
  • value (::String) — The three-letter currency code defined in ISO 4217.
Returns
  • (::String) — The three-letter currency code defined in ISO 4217.

#nanos

def nanos() -> ::Integer
Returns
  • (::Integer) — Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

#nanos=

def nanos=(value) -> ::Integer
Parameter
  • value (::Integer) — Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
Returns
  • (::Integer) — Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

#units

def units() -> ::Integer
Returns
  • (::Integer) — The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

#units=

def units=(value) -> ::Integer
Parameter
  • value (::Integer) — The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
Returns
  • (::Integer) — The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.