Reference documentation and code samples for the Compute V1 Client class Money.
Represents an amount of money with its currency type.
Generated from protobuf message google.cloud.compute.v1.Money
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ currency_code |
string
The three-letter currency code defined in ISO 4217. |
↳ nanos |
int
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If |
↳ units |
int|string
The whole units of the amount. For example if |
getCurrencyCode
The three-letter currency code defined in ISO 4217.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCurrencyCode
clearCurrencyCode
setCurrencyCode
The three-letter currency code defined in ISO 4217.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNanos
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 | |
|---|---|
| Type | Description |
int |
|
hasNanos
clearNanos
setNanos
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnits
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasUnits
clearUnits
setUnits
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|