Skip to main content

Class: CreateWorkflowRuleResponse

workflowservice.v1.CreateWorkflowRuleResponse

Represents a CreateWorkflowRuleResponse.

Properties​

jobId​

• jobId: string

Batch Job ID if force-scan flag was provided. Otherwise empty.


rule​

• Optional rule: null | $Properties

Created rule.

Methods​

toJSON​

▸ toJSON(): Object

Converts this CreateWorkflowRuleResponse to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): CreateWorkflowRuleResponse & $Shape

Creates a new CreateWorkflowRuleResponse instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

CreateWorkflowRuleResponse & $Shape

CreateWorkflowRuleResponse instance

▸ create(properties?): CreateWorkflowRuleResponse

Parameters​

NameType
properties?$Properties

Returns​

CreateWorkflowRuleResponse


decode​

▸ decode(reader, length?): CreateWorkflowRuleResponse & $Shape

Decodes a CreateWorkflowRuleResponse message from the specified reader or buffer.

Parameters​

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

Returns​

CreateWorkflowRuleResponse & $Shape

CreateWorkflowRuleResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): CreateWorkflowRuleResponse & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

CreateWorkflowRuleResponse & $Shape

CreateWorkflowRuleResponse

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

Parameters​

NameTypeDescription
message$PropertiesCreateWorkflowRuleResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesCreateWorkflowRuleResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): CreateWorkflowRuleResponse

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

CreateWorkflowRuleResponse

CreateWorkflowRuleResponse


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageCreateWorkflowRuleResponseCreateWorkflowRuleResponse
options?IConversionOptionsConversion options

Returns​

Object

Plain object