Represents a RequestHeader.
Package
@googlemaps/fleetengineConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.v1.IRequestHeader);Constructs a new RequestHeader.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRequestHeader
Properties to set |
Properties
androidApiLevel
public androidApiLevel: number;RequestHeader androidApiLevel.
deviceModel
public deviceModel: string;RequestHeader deviceModel.
languageCode
public languageCode: string;RequestHeader languageCode.
manufacturer
public manufacturer: string;RequestHeader manufacturer.
mapsSdkVersion
public mapsSdkVersion: string;RequestHeader mapsSdkVersion.
navSdkVersion
public navSdkVersion: string;RequestHeader navSdkVersion.
osVersion
public osVersion: string;RequestHeader osVersion.
platform
public platform: (maps.fleetengine.v1.RequestHeader.Platform|keyof typeof maps.fleetengine.v1.RequestHeader.Platform);RequestHeader platform.
regionCode
public regionCode: string;RequestHeader regionCode.
sdkType
public sdkType: (maps.fleetengine.v1.RequestHeader.SdkType|keyof typeof maps.fleetengine.v1.RequestHeader.SdkType);RequestHeader sdkType.
sdkVersion
public sdkVersion: string;RequestHeader sdkVersion.
traceId
public traceId: string;RequestHeader traceId.
Methods
create(properties)
public static create(properties?: maps.fleetengine.v1.IRequestHeader): maps.fleetengine.v1.RequestHeader;Creates a new RequestHeader instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRequestHeader
Properties to set |
| Returns | |
|---|---|
| Type | Description |
RequestHeader |
RequestHeader instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.v1.RequestHeader;Decodes a RequestHeader message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
RequestHeader |
RequestHeader |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.v1.RequestHeader;Decodes a RequestHeader message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
RequestHeader |
RequestHeader |
encode(message, writer)
public static encode(message: maps.fleetengine.v1.IRequestHeader, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RequestHeader message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRequestHeader
RequestHeader message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: maps.fleetengine.v1.IRequestHeader, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RequestHeader message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRequestHeader
RequestHeader message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): maps.fleetengine.v1.RequestHeader;Creates a RequestHeader message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
RequestHeader |
RequestHeader |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for RequestHeader
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this RequestHeader to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.v1.RequestHeader, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a RequestHeader message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
RequestHeader
RequestHeader |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a RequestHeader message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|