Skip to main content

Class: StopBatchOperationRequest

workflowservice.v1.StopBatchOperationRequest

Represents a StopBatchOperationRequest.

Implements

Constructors

constructor

new StopBatchOperationRequest(properties?): StopBatchOperationRequest

Constructs a new StopBatchOperationRequest.

Parameters

NameTypeDescription
properties?IStopBatchOperationRequestProperties to set

Returns

StopBatchOperationRequest

Properties

identity

identity: string

Identity of the operator

Implementation of

IStopBatchOperationRequest.identity


jobId

jobId: string

Batch job id

Implementation of

IStopBatchOperationRequest.jobId


namespace

namespace: string

Namespace that contains the batch operation

Implementation of

IStopBatchOperationRequest.namespace


reason

reason: string

Reason to stop a batch operation

Implementation of

IStopBatchOperationRequest.reason

Methods

toJSON

toJSON(): Object

Converts this StopBatchOperationRequest to JSON.

Returns

Object

JSON object


create

create(properties?): StopBatchOperationRequest

Creates a new StopBatchOperationRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IStopBatchOperationRequestProperties to set

Returns

StopBatchOperationRequest

StopBatchOperationRequest instance


decode

decode(reader, length?): StopBatchOperationRequest

Decodes a StopBatchOperationRequest message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

StopBatchOperationRequest

StopBatchOperationRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): StopBatchOperationRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

StopBatchOperationRequest

StopBatchOperationRequest

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

Parameters

NameTypeDescription
messageIStopBatchOperationRequestStopBatchOperationRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIStopBatchOperationRequestStopBatchOperationRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): StopBatchOperationRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

StopBatchOperationRequest

StopBatchOperationRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for StopBatchOperationRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageStopBatchOperationRequestStopBatchOperationRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object