Class: BatchJob
A link to a built-in batch job. Batch jobs can be used to perform operations on a set of workflows (e.g. terminate, signal, cancel, etc). This link can be put on workflow history events generated by actions taken by a batch job.
Implements
Constructors
constructor
• new BatchJob(properties?): BatchJob
Constructs a new BatchJob.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchJob | Properties to set |
Returns
Properties
jobId
• jobId: string
BatchJob jobId.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this BatchJob to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchJob
Creates a new BatchJob instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchJob | Properties to set |
Returns
BatchJob instance
decode
▸ decode(reader, length?): BatchJob
Decodes a BatchJob 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
BatchJob
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchJob
Decodes a BatchJob message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchJob
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 BatchJob message. Does not implicitly temporal.api.common.v1.Link.BatchJob.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchJob | BatchJob message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchJob message, length delimited. Does not implicitly temporal.api.common.v1.Link.BatchJob.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchJob | BatchJob message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchJob
Creates a BatchJob message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchJob
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for BatchJob
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 BatchJob message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchJob | BatchJob |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object