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

  • new BoundTask(properties?): BoundTask

  • Constructs a new BoundTask.

    Parameters

    Returns BoundTask

Properties

Optional lowerBound

lowerBound?: 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}.

Optional onExceedsLowerBound

onExceedsLowerBound?: 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}.

Optional onExceedsUpperBound

onExceedsUpperBound?: 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}.

Optional upperBound

upperBound?: 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

    • [k: string]: any

Static create

  • create(properties?): BoundTask

  • Creates a new BoundTask instance using the specified properties.

    Parameters

    Returns BoundTask

    BoundTask instance

Static decode

  • decode(reader, length?): BoundTask

  • Decodes a BoundTask message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: 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

Static decodeDelimited

  • decodeDelimited(reader): BoundTask

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

    Parameters

    • reader: Uint8Array | 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

Static encode

  • encode(message, writer?): Writer

  • Encodes the specified BoundTask message. Does not implicitly verify messages.

    Parameters

    • message: IBoundTask

      BoundTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message, writer?): Writer

  • Encodes the specified BoundTask message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IBoundTask

      BoundTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

  • fromObject(object): BoundTask

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns BoundTask

    BoundTask

Static getTypeUrl

  • getTypeUrl(typeUrlPrefix?): string

  • Gets the default type url for BoundTask

    Parameters

    • Optional typeUrlPrefix: string

      your custom typeUrlPrefix(default "type.googleapis.com")

    Returns string

    The default type url

Static toObject

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

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

    Parameters

    • message: BoundTask

      BoundTask

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • verify(message): string

  • Verifies a BoundTask message.

    Parameters

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

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc