Skip to main content

Class: DeleteWorkflowRuleRequest

Represents a DeleteWorkflowRuleRequest.

Properties​

namespace​

namespace: string

DeleteWorkflowRuleRequest namespace.

ruleId​

ruleId: string

ID of the rule to delete. Unique within the namespace.

Methods​

toJSON()​

toJSON(): object

Converts this DeleteWorkflowRuleRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DeleteWorkflowRuleRequest & $Properties

Creates a new DeleteWorkflowRuleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteWorkflowRuleRequest & $Properties

DeleteWorkflowRuleRequest instance

Call Signature​

static create(properties?): DeleteWorkflowRuleRequest

Creates a new DeleteWorkflowRuleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteWorkflowRuleRequest

DeleteWorkflowRuleRequest instance

decode()​

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

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

DeleteWorkflowRuleRequest & $Properties

DeleteWorkflowRuleRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DeleteWorkflowRuleRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DeleteWorkflowRuleRequest & $Properties

DeleteWorkflowRuleRequest

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

Parameters​

message​

$Properties

DeleteWorkflowRuleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DeleteWorkflowRuleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeleteWorkflowRuleRequest

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

Parameters​

object​

Plain object

Returns​

DeleteWorkflowRuleRequest

DeleteWorkflowRuleRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DeleteWorkflowRuleRequest

DeleteWorkflowRuleRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object