Class CacheTask

Execute a job and store the result in a variable to reference later.

Input: None

Returns: The input

Example: CacheTask storing ${ONE} = 1

{ "cacheTask": { "cacheItems": [ { "variableName": "ONE", "job": { "tasks": [ { "valueTask": { "value": 1 } } ] } } ] } }

Implements

Constructors

constructor

Properties

cacheItems

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new CacheTask(properties?: ICacheTask): OracleJob.CacheTask

    Constructs a new CacheTask.

    Parameters

    Returns OracleJob.CacheTask

Properties

cacheItems

cacheItems: ICacheItem[]

A list of cached variables to reference in the job with ${VARIABLE_NAME}.

Methods

toJSON

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

    Converts this CacheTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: ICacheTask): OracleJob.CacheTask

    Creates a new CacheTask instance using the specified properties.

    Parameters

    Returns OracleJob.CacheTask

    CacheTask instance

Staticdecode

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

    Decodes a CacheTask 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.CacheTask

    CacheTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns OracleJob.CacheTask

    CacheTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

    Encodes the specified CacheTask message. Does not implicitly verify messages.

    Parameters

    • message: ICacheTask

      CacheTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: ICacheTask

      CacheTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns OracleJob.CacheTask

    CacheTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for CacheTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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

    Parameters

    • message: OracleJob.CacheTask

      CacheTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

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

    Verifies a CacheTask message.

    Parameters

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

      Plain object to verify

    Returns string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods