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

  • new JsonParseTask(properties?): JsonParseTask

  • Constructs a new JsonParseTask.

    Parameters

    Returns JsonParseTask

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

    • [k: string]: any

Static create

  • create(properties?): JsonParseTask

  • Creates a new JsonParseTask instance using the specified properties.

    Parameters

    Returns JsonParseTask

    JsonParseTask instance

Static decode

  • decode(reader, length?): JsonParseTask

  • Decodes a JsonParseTask 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 JsonParseTask

    JsonParseTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static decodeDelimited

  • decodeDelimited(reader): JsonParseTask

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns JsonParseTask

    JsonParseTask

    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 JsonParseTask message. Does not implicitly verify messages.

    Parameters

    • message: IJsonParseTask

      JsonParseTask 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 JsonParseTask message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IJsonParseTask

      JsonParseTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

  • fromObject(object): JsonParseTask

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns JsonParseTask

    JsonParseTask

Static getTypeUrl

  • getTypeUrl(typeUrlPrefix?): string

  • Gets the default type url for JsonParseTask

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

    Parameters

    • message: JsonParseTask

      JsonParseTask

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • verify(message): string

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