Skip to main content

Class: StopBatchOperationRequest

Represents a StopBatchOperationRequest.

Properties​

identity​

identity: string

Identity of the operator

jobId​

jobId: string

Batch job id

namespace​

namespace: string

Namespace that contains the batch operation

reason​

reason: string

Reason to stop a batch operation

Methods​

toJSON()​

toJSON(): object

Converts this StopBatchOperationRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StopBatchOperationRequest & $Properties

Creates a new StopBatchOperationRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StopBatchOperationRequest & $Properties

StopBatchOperationRequest instance

Call Signature​

static create(properties?): StopBatchOperationRequest

Creates a new StopBatchOperationRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StopBatchOperationRequest

StopBatchOperationRequest instance

decode()​

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

Decodes a StopBatchOperationRequest 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​

StopBatchOperationRequest & $Properties

StopBatchOperationRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): StopBatchOperationRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

StopBatchOperationRequest & $Properties

StopBatchOperationRequest

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 StopBatchOperationRequest message. Does not implicitly temporal.api.workflowservice.v1.StopBatchOperationRequest.verify|verify messages.

Parameters​

message​

$Properties

StopBatchOperationRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

StopBatchOperationRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StopBatchOperationRequest

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

Parameters​

object​

Plain object

Returns​

StopBatchOperationRequest

StopBatchOperationRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

StopBatchOperationRequest

StopBatchOperationRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object