Class: DescribeBatchOperationResponse
workflowservice.v1.DescribeBatchOperationResponse
Represents a DescribeBatchOperationResponse.
Properties
closeTime
• Optional closeTime: null | $Properties
Batch operation close time
completeOperationCount
• completeOperationCount: Long
Complete operation count
executions
• executions: $Properties[]
Executions is the list of workflow OR standalone activity executions to apply the batch operation
failureOperationCount
• failureOperationCount: Long
Failure operation count
identity
• identity: string
Identity indicates the operator identity
jobId
• jobId: string
Batch job ID
operationType
• operationType: BatchOperationType
Batch operation type
query
• query: string
Query is the visibility query that defines the group of workflow to apply the batch operation
reason
• reason: string
Reason indicates the reason to stop a operation
startTime
• Optional startTime: null | $Properties
Batch operation start time
state
• state: BatchOperationState
Batch operation state
totalOperationCount
• totalOperationCount: Long
Total operation count
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeBatchOperationResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeBatchOperationResponse & $Properties
Creates a new DescribeBatchOperationResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DescribeBatchOperationResponse & $Properties
DescribeBatchOperationResponse instance
▸ create(properties?): DescribeBatchOperationResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
DescribeBatchOperationResponse
decode
▸ decode(reader, length?): DescribeBatchOperationResponse & $Properties
Decodes a DescribeBatchOperationResponse 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
DescribeBatchOperationResponse & $Properties
DescribeBatchOperationResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeBatchOperationResponse & $Properties
Decodes a DescribeBatchOperationResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescribeBatchOperationResponse & $Properties
DescribeBatchOperationResponse
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 DescribeBatchOperationResponse message. Does not implicitly temporal.api.workflowservice.v1.DescribeBatchOperationResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeBatchOperationResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescribeBatchOperationResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeBatchOperationResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeBatchOperationResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescribeBatchOperationResponse
Creates a DescribeBatchOperationResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeBatchOperationResponse
DescribeBatchOperationResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DescribeBatchOperationResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeBatchOperationResponse | DescribeBatchOperationResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object