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.



9701
9702
9703
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 9701

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) 


9684
9685
9686
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 9684

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) 


9693
9694
9695
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 9693

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) 


9699
9700
9701
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 9699

def units
  @units
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9706
9707
9708
9709
9710
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 9706

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