Class: BatchOperationInfo
Represents a BatchOperationInfo.
Properties
closeTime
• Optional closeTime: null | $Properties
Batch operation close time
jobId
• jobId: string
Batch job ID
operationType
• operationType: BatchOperationType
Operation type
startTime
• Optional startTime: null | $Properties
Batch operation start time
state
• state: BatchOperationState
Batch operation state
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationInfo & $Properties
Creates a new BatchOperationInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
BatchOperationInfo & $Properties
BatchOperationInfo instance
▸ create(properties?): BatchOperationInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): BatchOperationInfo & $Properties
Decodes a BatchOperationInfo 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
BatchOperationInfo & $Properties
BatchOperationInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationInfo & $Properties
Decodes a BatchOperationInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationInfo & $Properties
BatchOperationInfo
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 BatchOperationInfo message. Does not implicitly temporal.api.batch.v1.BatchOperationInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationInfo message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationInfo
Creates a BatchOperationInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a BatchOperationInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationInfo | BatchOperationInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object