Skip to main content

Class: Rejection

update.v1.Rejection

An Update protocol message indicating that a Workflow Update has been rejected.

Implements

Constructors

constructor

new Rejection(properties?): Rejection

Constructs a new Rejection.

Parameters

NameTypeDescription
properties?IRejectionProperties to set

Returns

Rejection

Properties

failure

Optional failure: null | IFailure

Rejection failure.

Implementation of

IRejection.failure


rejectedRequest

Optional rejectedRequest: null | IRequest

Rejection rejectedRequest.

Implementation of

IRejection.rejectedRequest


rejectedRequestMessageId

rejectedRequestMessageId: string

Rejection rejectedRequestMessageId.

Implementation of

IRejection.rejectedRequestMessageId


rejectedRequestSequencingEventId

rejectedRequestSequencingEventId: Long

Rejection rejectedRequestSequencingEventId.

Implementation of

IRejection.rejectedRequestSequencingEventId

Methods

toJSON

toJSON(): Object

Converts this Rejection to JSON.

Returns

Object

JSON object


create

create(properties?): Rejection

Creates a new Rejection instance using the specified properties.

Parameters

NameTypeDescription
properties?IRejectionProperties to set

Returns

Rejection

Rejection instance


decode

decode(reader, length?): Rejection

Decodes a Rejection message from the specified reader or buffer.

Parameters

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

Returns

Rejection

Rejection

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Rejection

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Rejection

Rejection

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): Rejection

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Rejection

Rejection


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Rejection

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

Parameters

NameTypeDescription
messageRejectionRejection
options?IConversionOptionsConversion options

Returns

Object

Plain object