Skip to main content

Class: CreateWorkflowRuleResponse

workflowservice.v1.CreateWorkflowRuleResponse

Represents a CreateWorkflowRuleResponse.

Implements

Constructors

constructor

new CreateWorkflowRuleResponse(properties?): CreateWorkflowRuleResponse

Constructs a new CreateWorkflowRuleResponse.

Parameters

NameTypeDescription
properties?ICreateWorkflowRuleResponseProperties to set

Returns

CreateWorkflowRuleResponse

Properties

jobId

jobId: string

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

Implementation of

ICreateWorkflowRuleResponse.jobId


rule

Optional rule: null | IWorkflowRule

Created rule.

Implementation of

ICreateWorkflowRuleResponse.rule

Methods

toJSON

toJSON(): Object

Converts this CreateWorkflowRuleResponse to JSON.

Returns

Object

JSON object


create

create(properties?): CreateWorkflowRuleResponse

Creates a new CreateWorkflowRuleResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?ICreateWorkflowRuleResponseProperties to set

Returns

CreateWorkflowRuleResponse

CreateWorkflowRuleResponse instance


decode

decode(reader, length?): CreateWorkflowRuleResponse

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

CreateWorkflowRuleResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): CreateWorkflowRuleResponse

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

CreateWorkflowRuleResponse

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
messageICreateWorkflowRuleResponseCreateWorkflowRuleResponse 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
messageICreateWorkflowRuleResponseCreateWorkflowRuleResponse 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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CreateWorkflowRuleResponse

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 CreateWorkflowRuleResponse message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageCreateWorkflowRuleResponseCreateWorkflowRuleResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object