Class: BatchOperationInfo
Represents a BatchOperationInfo.
Implements
Constructors
constructor
• new BatchOperationInfo(properties?): BatchOperationInfo
Constructs a new BatchOperationInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationInfo | Properties to set |
Returns
Properties
closeTime
• Optional closeTime: null | ITimestamp
Batch operation close time
Implementation of
jobId
• jobId: string
Batch job ID
Implementation of
startTime
• Optional startTime: null | ITimestamp
Batch operation start time
Implementation of
state
• state: BatchOperationState
Batch operation state
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationInfo
Creates a new BatchOperationInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationInfo | Properties to set |
Returns
BatchOperationInfo instance
decode
▸ decode(reader, length?): BatchOperationInfo
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationInfo
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
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 | IBatchOperationInfo | 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 | IBatchOperationInfo | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for BatchOperationInfo
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 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