Skip to main content

Class: Header

common.v1.Header

Represents a Header.

Implements

Constructors

constructor

new Header(properties?)

Constructs a new Header.

Parameters

NameTypeDescription
properties?IHeaderProperties to set

Properties

fields

fields: Object

Header fields.

Index signature

[k: string]: IPayload

Implementation of

IHeader.fields

Methods

toJSON

toJSON(): Object

Converts this Header to JSON.

Returns

Object

JSON object


create

Static create(properties?): Header

Creates a new Header instance using the specified properties.

Parameters

NameTypeDescription
properties?IHeaderProperties to set

Returns

Header

Header instance


decode

Static decode(reader, length?): Header

Decodes a Header message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

Header

Header


decodeDelimited

Static decodeDelimited(reader): Header

Decodes a Header message from the specified reader or buffer, length delimited.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Header

Header


encode

Static encode(message, writer?): Writer

Encodes the specified Header message. Does not implicitly temporal.api.common.v1.Header.verify|verify messages.

Parameters

NameTypeDescription
messageIHeaderHeader message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

Encodes the specified Header message, length delimited. Does not implicitly temporal.api.common.v1.Header.verify|verify messages.

Parameters

NameTypeDescription
messageIHeaderHeader message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

Static fromObject(object): Header

Creates a Header message from a plain object. Also converts values to their respective internal types.

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Header

Header


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Header

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

Creates a plain object from a Header message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageHeaderHeader
options?IConversionOptionsConversion options

Returns

Object

Plain object