Class BoundTask

Bound the running result to an upper/lower bound. This is typically the last task in an OracleJob.

Input: The current running numerical result.

Returns: The running result bounded to an upper or lower bound if it exceeds a given threshold.

Example: Bound the running result to a value between 0.90 and 1.10

{ "boundTask": { "lowerBoundValue": "0.90","onExceedsLowerBoundValue": "0.90","upperBoundValue": "1.10","onExceedsUpperBoundValue": "1.10" } }

Implements

Constructors

constructor

Properties

lowerBound? lowerBoundValue onExceedsLowerBound? onExceedsLowerBoundValue onExceedsUpperBound? onExceedsUpperBoundValue upperBound? upperBoundValue

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

OptionallowerBound

lowerBound?: null | IOracleJob

The OracleJob to execute for the lower bound value.

lowerBoundValue

lowerBoundValue: string

The value to use for the lower bound. Can be set to a ${CACHE_KEY}.

OptionalonExceedsLowerBound

onExceedsLowerBound?: null | IOracleJob

The OracleJob to execute if the lower bound is exceeded.

onExceedsLowerBoundValue

onExceedsLowerBoundValue: string

The value to use if the lower bound is exceeded. Can be set to a ${CACHE_KEY}.

OptionalonExceedsUpperBound

onExceedsUpperBound?: null | IOracleJob

The OracleJob to execute if the upper bound is exceeded.

onExceedsUpperBoundValue

onExceedsUpperBoundValue: string

The value to use if the upper bound is exceeded. Can be set to a ${CACHE_KEY}.

OptionalupperBound

upperBound?: null | IOracleJob

The OracleJob to execute for the upper bound value.

upperBoundValue

upperBoundValue: string

The value to use for the upper bound. Can be set to a ${CACHE_KEY}.

Methods

toJSON

  • toJSON(): { [k: string]: any }

    Converts this BoundTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: IBoundTask): BoundTask

    Creates a new BoundTask instance using the specified properties.

    Parameters

    Returns BoundTask

    BoundTask instance

Staticdecode

  • decode(reader: Uint8Array<ArrayBufferLike> | Reader, length?: number): BoundTask

    Decodes a BoundTask message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    • Optionallength: number

      Message length if known beforehand

    Returns BoundTask

    BoundTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

  • decodeDelimited(reader: Uint8Array<ArrayBufferLike> | Reader): BoundTask

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns BoundTask

    BoundTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

  • encode(message: IBoundTask, writer?: Writer): Writer

    Encodes the specified BoundTask message. Does not implicitly {@apilink oracle_job.OracleJob.BoundTask.verify|verify} messages.

    Parameters

    • message: IBoundTask

      BoundTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

  • encodeDelimited(message: IBoundTask, writer?: Writer): Writer

    Encodes the specified BoundTask message, length delimited. Does not implicitly {@apilink oracle_job.OracleJob.BoundTask.verify|verify} messages.

    Parameters

    • message: IBoundTask

      BoundTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

  • fromObject(object: { [k: string]: any }): BoundTask

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

    Parameters

    • object: { [k: string]: any }

      Plain object

    Returns BoundTask

    BoundTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for BoundTask

    Parameters

    Returns string

    The default type url

StatictoObject

  • toObject(message: BoundTask, options?: IConversionOptions): { [k: string]: any }

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

    Parameters

    • message: BoundTask

      BoundTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

  • verify(message: { [k: string]: any }): null | string

    Verifies a BoundTask message.

    Parameters

    • message: { [k: string]: any }

      Plain object to verify

    Returns null | string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods