Class: ResetOperation
v1.UnpauseActivityByIdRequest.ResetOperation
Represents a ResetOperation.
Implements
Constructors
constructor
• new ResetOperation(properties?): ResetOperation
Constructs a new ResetOperation.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IResetOperation | Properties to set |
Returns
Properties
noWait
• noWait: boolean
Indicates that the activity should be scheduled immediately. Note that this may run simultaneously with any existing executions of the activity.
Implementation of
resetHeartbeat
• resetHeartbeat: boolean
If set, the Heartbeat Details will be cleared out to make the Activity start over from the beginning
Implementation of
IResetOperation.resetHeartbeat
Methods
toJSON
▸ toJSON(): Object
Converts this ResetOperation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ResetOperation
Creates a new ResetOperation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IResetOperation | Properties to set |
Returns
ResetOperation instance
decode
▸ decode(reader, length?): ResetOperation
Decodes a ResetOperation 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
ResetOperation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ResetOperation
Decodes a ResetOperation message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ResetOperation
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 ResetOperation message. Does not implicitly temporal.api.workflowservice.v1.UnpauseActivityByIdRequest.ResetOperation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IResetOperation | ResetOperation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ResetOperation message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UnpauseActivityByIdRequest.ResetOperation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IResetOperation | ResetOperation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ResetOperation
Creates a ResetOperation message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ResetOperation
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ResetOperation
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 ResetOperation message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ResetOperation | ResetOperation |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object