Skip to main content

Class: DescribeBatchOperationResponse

Represents a DescribeBatchOperationResponse.

Properties​

closeTime?​

optional closeTime?: $Properties | null

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?: $Properties | null

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()​

Call Signature​

static create(properties?): DescribeBatchOperationResponse & $Properties

Creates a new DescribeBatchOperationResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeBatchOperationResponse & $Properties

DescribeBatchOperationResponse instance

Call Signature​

static create(properties?): DescribeBatchOperationResponse

Creates a new DescribeBatchOperationResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeBatchOperationResponse

DescribeBatchOperationResponse instance

decode()​

static decode(reader, length?): DescribeBatchOperationResponse & $Properties

Decodes a DescribeBatchOperationResponse message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static decodeDelimited(reader): DescribeBatchOperationResponse & $Properties

Decodes a DescribeBatchOperationResponse message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified DescribeBatchOperationResponse message. Does not implicitly temporal.api.workflowservice.v1.DescribeBatchOperationResponse.verify|verify messages.

Parameters​

message​

$Properties

DescribeBatchOperationResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified DescribeBatchOperationResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeBatchOperationResponse.verify|verify messages.

Parameters​

message​

$Properties

DescribeBatchOperationResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeBatchOperationResponse

Creates a DescribeBatchOperationResponse message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

DescribeBatchOperationResponse

DescribeBatchOperationResponse

toObject()​

static toObject(message, options?): object

Creates a plain object from a DescribeBatchOperationResponse message. Also converts values to other types if specified.

Parameters​

message​

DescribeBatchOperationResponse

DescribeBatchOperationResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object