Class: Google::Apis::DocumentaiV1::GoogleTypeMoney

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb

Overview

Represents an amount of money with its currency type.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleTypeMoney

Returns a new instance of GoogleTypeMoney.



7811
7812
7813
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7811

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#currency_code ⇒ String

The three-letter currency code defined in ISO 4217. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


7794
7795
7796
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7794

def currency_code
  @currency_code
end

#nanos ⇒ Fixnum

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. Corresponds to the JSON property nanos

Returns:

  • (Fixnum) 


7803
7804
7805
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7803

def nanos
  @nanos
end

#units ⇒ Fixnum

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar. Corresponds to the JSON property units

Returns:

  • (Fixnum) 


7809
7810
7811
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7809

def units
  @units
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7816
7817
7818
7819
7820
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7816

def update!(**args)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @nanos = args[:nanos] if args.key?(:nanos)
  @units = args[:units] if args.key?(:units)
end