Class: RequestIdInfo
RequestIdInfo contains details of a request ID.
Implements
Constructors
constructor
• new RequestIdInfo(properties?): RequestIdInfo
Constructs a new RequestIdInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestIdInfo | Properties to set |
Returns
Properties
buffered
• buffered: boolean
Indicate if the request is still buffered. If so, the event ID is not known and its value will be an invalid event ID.
Implementation of
eventId
• eventId: Long
The event id of the history event generated by the request. It's possible the event ID is not known (unflushed buffered event). In this case, the value will be zero or a negative value, representing an invalid ID.
Implementation of
eventType
• eventType: EventType
The event type of the history event generated by the request.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this RequestIdInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestIdInfo
Creates a new RequestIdInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestIdInfo | Properties to set |
Returns
RequestIdInfo instance
decode
▸ decode(reader, length?): RequestIdInfo
Decodes a RequestIdInfo 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
RequestIdInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestIdInfo
Decodes a RequestIdInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RequestIdInfo
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 RequestIdInfo message. Does not implicitly temporal.api.workflow.v1.RequestIdInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestIdInfo | RequestIdInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestIdInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.RequestIdInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestIdInfo | RequestIdInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestIdInfo
Creates a RequestIdInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestIdInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RequestIdInfo
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 RequestIdInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestIdInfo | RequestIdInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object