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

  • Constructs a new CacheTask.

    Parameters

    Returns CacheTask

Properties

cacheItems: ICacheItem[]

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

Methods

  • Converts this CacheTask to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Creates a new CacheTask instance using the specified properties.

    Parameters

    Returns CacheTask

    CacheTask instance

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

    CacheTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns CacheTask

    CacheTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: ICacheTask

      CacheTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: ICacheTask

      CacheTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns CacheTask

    CacheTask

  • Gets the default type url for CacheTask

    Parameters

    • Optional typeUrlPrefix: string

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

    Returns string

    The default type url

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

    Parameters

    • message: CacheTask

      CacheTask

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a CacheTask 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