Class: RequestIdReference
Link.WorkflowEvent.RequestIdReference
RequestIdReference is a indirect reference to a history event through the request ID.
Implements
Constructors
constructor
• new RequestIdReference(properties?): RequestIdReference
Constructs a new RequestIdReference.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestIdReference | Properties to set |
Returns
Properties
eventType
• eventType: EventType
RequestIdReference eventType.
Implementation of
requestId
• requestId: string
RequestIdReference requestId.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this RequestIdReference to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestIdReference
Creates a new RequestIdReference instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestIdReference | Properties to set |
Returns
RequestIdReference instance
decode
▸ decode(reader, length?): RequestIdReference
Decodes a RequestIdReference 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
RequestIdReference
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestIdReference
Decodes a RequestIdReference message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RequestIdReference
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 RequestIdReference message. Does not implicitly temporal.api.common.v1.Link.WorkflowEvent.RequestIdReference.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestIdReference | RequestIdReference message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestIdReference message, length delimited. Does not implicitly temporal.api.common.v1.Link.WorkflowEvent.RequestIdReference.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestIdReference | RequestIdReference message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestIdReference
Creates a RequestIdReference message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestIdReference
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RequestIdReference
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 RequestIdReference message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestIdReference | RequestIdReference |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object