Class ComparisonTask

Represents a ComparisonTask.

Implements

Constructors

constructor

Properties

LHS? RHS? lhs? lhsValue? onFailure? onFailureValue onFalse? onFalseValue onTrue? onTrueValue op rhs? rhsValue?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

Optional LHS

LHS?: "lhs" | "lhsValue"

ComparisonTask LHS.

Optional RHS

RHS?: "rhs" | "rhsValue"

ComparisonTask RHS.

Optional lhs

lhs?: IOracleJob

OracleJob where the executed result is equal to the left hand side operand.

Optional lhsValue

lhsValue?: string

String or ${CACHE_KEY} representing the left hand side operand.

Optional onFailure

onFailure?: IOracleJob

The OracleJob to execute if the condition fails to evaluate.

onFailureValue

onFailureValue: string

The result to use if the condition fails to evaluate. Can be set to a ${CACHE_KEY}.

Optional onFalse

onFalse?: IOracleJob

The OracleJob to execute if the condition evaluates to false.

onFalseValue

onFalseValue: string

The result to use if the condition evaluates to false. Can be set to a ${CACHE_KEY}.

Optional onTrue

onTrue?: IOracleJob

The OracleJob to execute if the condition evaluates to true.

onTrueValue

onTrueValue: string

The result to use if the condition evaluates to true. Can be set to a ${CACHE_KEY}.

op

op: Operation

The type of operator to use on the left (lhs) and right (rhs) operand.

Optional rhs

rhs?: IOracleJob

OracleJob where the executed result is equal to the right hand side operand.

Optional rhsValue

rhsValue?: string

String or ${CACHE_KEY} representing the right hand side operand.

Methods

toJSON

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

  • Converts this ComparisonTask to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

  • create(properties?): ComparisonTask

  • Creates a new ComparisonTask instance using the specified properties.

    Parameters

    Returns ComparisonTask

    ComparisonTask instance

Static decode

  • decode(reader, length?): ComparisonTask

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

    ComparisonTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static decodeDelimited

  • decodeDelimited(reader): ComparisonTask

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns ComparisonTask

    ComparisonTask

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

    Parameters

    • message: IComparisonTask

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

    Parameters

    • message: IComparisonTask

      ComparisonTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

  • fromObject(object): ComparisonTask

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns ComparisonTask

    ComparisonTask

Static getTypeUrl

  • getTypeUrl(typeUrlPrefix?): string

  • Gets the default type url for ComparisonTask

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

    Parameters

    • message: ComparisonTask

      ComparisonTask

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • verify(message): string

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