Class JsonParseTask

The adapter walks the path specified and returns the value found at that result. If returning JSON data from the HttpGet or HttpPost adapters, you must use this adapter to parse the response.

Input: String representation of a JSON object.

Returns: A numerical result.

Example: Parses the price field from a JSON object

{"jsonParse": {"path": "$.price"} }

Implements

Constructors

constructor

Properties

aggregationMethod path

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

aggregationMethod

aggregationMethod: AggregationMethod

The technique that will be used to aggregate the results if walking the specified path returns multiple numerical results.

path

path: string

JSONPath formatted path to the element. https://t.ly/uLtw https://www.npmjs.com/package/jsonpath-plus

Methods

toJSON

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

    Converts this JsonParseTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

Staticdecode

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

    Decodes a JsonParseTask 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 OracleJob.JsonParseTask

    JsonParseTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

  • decodeDelimited(
        reader: Uint8Array<ArrayBufferLike> | Reader,
    ): OracleJob.JsonParseTask

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns OracleJob.JsonParseTask

    JsonParseTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: IJsonParseTask

      JsonParseTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: IJsonParseTask

      JsonParseTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

  • fromObject(object: { [k: string]: any }): OracleJob.JsonParseTask

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

    Parameters

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

      Plain object

    Returns OracleJob.JsonParseTask

    JsonParseTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for JsonParseTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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

    Parameters

    Returns { [k: string]: any }

    Plain object

Staticverify

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

    Verifies a JsonParseTask 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