Location Property
The Google Cloud location to make requests against.
Syntax
googlekms.getLocation([callback]) googlekms.setLocation( location, [callback])
Default Value
"us"
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getLocation([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setLocation([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property specifies the Google Cloud location that the class should make requests against.
Regional Locations:
A regional location's data centers exist in a specific geographical place.
Value | Description |
asia-east1 | Taiwan |
asia-east2 | Hong Kong |
asia-northeast1 | Tokyo |
asia-northeast2 | Osaka |
asia-northeast3 | Seoul |
asia-south1 | Mumbai |
asia-southeast1 | Singapore |
asia-southeast2 | Jakarta |
australia-southeast1 | Sydney |
europe-north1 | Finland |
europe-west1 | Belgium |
europe-west2 | London |
europe-west3 | Frankfurt |
europe-west4 | Netherlands |
europe-west6 | Zurich |
northamerica-northeast1 | Montreal |
us-central1 | Iowa |
us-east1 | South Carolina |
us-east4 | Northern Virginia |
us-west1 | Oregon |
us-west2 | Los Angeles |
us-west3 | Salt Lake City |
us-west4 | Las Vegas |
southamerica-east1 | Sao Paulo |
Dual-Regional Locations:
A dual-regional location's data centers exist in two specific geographical places (plus a third region included for data replication and durability).
Value | Description (bold indicates third replica) |
asia1 | Tokyo, Osaka, and Seoul |
eur4 | Finland, Netherlands, and Belgium |
nam4 | Iowa, South Carolina, and Oklahoma |
Multi-Regional Locations:
A multi-regional location's data centers are spread across a geographical area; it is not possible to predict or control exactly which data centers are selected or where they are located.
Value | Description |
global | Multiple data centers throughout the world |
asia | Multiple data centers in Asia |
europe | Multiple data centers in Europe |
us (default) | Multiple data centers in the US |
The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.
This property is not available at design time.
Data Type
String