Class: Header
Contains metadata that can be attached to a variety of requests, like starting a workflow, and can be propagated between, for example, workflows and activities.
Implements
Constructors
constructor
• new Header(properties?): Header
Constructs a new Header.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IHeader | Properties to set |
Returns
Properties
fields
• fields: Object
Header fields.
Index signature
▪ [k: string]: IPayload
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Header to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Header
Creates a new Header instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IHeader | Properties to set |
Returns
Header instance
decode
▸ decode(reader, length?): Header
Decodes a Header message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Header
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Header
Decodes a Header message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Header
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Header message. Does not implicitly temporal.api.common.v1.Header.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IHeader | Header message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Header message, length delimited. Does not implicitly temporal.api.common.v1.Header.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IHeader | Header message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Header
Creates a Header message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Header
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Header
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Header message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Header | Header |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object