Reference documentation and code samples for the Google Maps FleetEngine V1 Client class RequestHeader.
A RequestHeader contains fields common to all Fleet Engine RPC requests.
Generated from protobuf message maps.fleetengine.v1.RequestHeader
Namespace
Google \ Maps \ FleetEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ language_code |
string
The BCP-47 language code, such as en-US or sr-Latn. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If none is specified, the response may be in any language, with a preference for English if such a name exists. Field value example: |
↳ region_code |
string
Required. CLDR region code of the region where the request originates. Field value example: |
↳ sdk_version |
string
Version of the calling SDK, if applicable. The version format is "major.minor.patch", example: |
↳ os_version |
string
Version of the operating system on which the calling SDK is running. Field value examples: |
↳ device_model |
string
Model of the device on which the calling SDK is running. Field value examples: |
↳ sdk_type |
int
The type of SDK sending the request. |
↳ maps_sdk_version |
string
Version of the MapSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: |
↳ nav_sdk_version |
string
Version of the NavSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: |
↳ platform |
int
Platform of the calling SDK. |
↳ manufacturer |
string
Manufacturer of the Android device from the calling SDK, only applicable for the Android SDKs. Field value example: |
↳ android_api_level |
int
Android API level of the calling SDK, only applicable for the Android SDKs. Field value example: |
↳ trace_id |
string
Optional ID that can be provided for logging purposes in order to identify the request. |
getLanguageCode
The BCP-47 language code, such as en-US or sr-Latn. For more information,
see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If none
is specified, the response may be in any language, with a preference for
English if such a name exists. Field value example: en-US.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLanguageCode
The BCP-47 language code, such as en-US or sr-Latn. For more information,
see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If none
is specified, the response may be in any language, with a preference for
English if such a name exists. Field value example: en-US.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegionCode
Required. CLDR region code of the region where the request originates.
Field value example: US.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRegionCode
Required. CLDR region code of the region where the request originates.
Field value example: US.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSdkVersion
Version of the calling SDK, if applicable.
The version format is "major.minor.patch", example: 1.1.2.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSdkVersion
Version of the calling SDK, if applicable.
The version format is "major.minor.patch", example: 1.1.2.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOsVersion
Version of the operating system on which the calling SDK is running.
Field value examples: 4.4.1, 12.1.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOsVersion
Version of the operating system on which the calling SDK is running.
Field value examples: 4.4.1, 12.1.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeviceModel
Model of the device on which the calling SDK is running.
Field value examples: iPhone12,1, SM-G920F.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDeviceModel
Model of the device on which the calling SDK is running.
Field value examples: iPhone12,1, SM-G920F.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSdkType
The type of SDK sending the request.
| Returns | |
|---|---|
| Type | Description |
int |
|
setSdkType
The type of SDK sending the request.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMapsSdkVersion
Version of the MapSDK which the calling SDK depends on, if applicable.
The version format is "major.minor.patch", example: 5.2.1.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMapsSdkVersion
Version of the MapSDK which the calling SDK depends on, if applicable.
The version format is "major.minor.patch", example: 5.2.1.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNavSdkVersion
Version of the NavSDK which the calling SDK depends on, if applicable.
The version format is "major.minor.patch", example: 2.1.0.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNavSdkVersion
Version of the NavSDK which the calling SDK depends on, if applicable.
The version format is "major.minor.patch", example: 2.1.0.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlatform
Platform of the calling SDK.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPlatform
Platform of the calling SDK.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getManufacturer
Manufacturer of the Android device from the calling SDK, only applicable for the Android SDKs.
Field value example: Samsung.
| Returns | |
|---|---|
| Type | Description |
string |
|
setManufacturer
Manufacturer of the Android device from the calling SDK, only applicable for the Android SDKs.
Field value example: Samsung.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAndroidApiLevel
Android API level of the calling SDK, only applicable for the Android SDKs.
Field value example: 23.
| Returns | |
|---|---|
| Type | Description |
int |
|
setAndroidApiLevel
Android API level of the calling SDK, only applicable for the Android SDKs.
Field value example: 23.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTraceId
Optional ID that can be provided for logging purposes in order to identify the request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTraceId
Optional ID that can be provided for logging purposes in order to identify the request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|