OBJECT

TimerNode

TimerNodes emit echo.timer messages on a time period defined by the scheduleExpression. They can be used to cause other Nodes (normally ProcessorNodes) to perform complex actions on a schedule (e.g. - polling an API every 15 minutes).

link GraphQL Schema definition

  • type TimerNode implements Node {
  • # When and who created.
  • created: AtBy!
  • # A human-readable description.
  • description: String
  • # When and who modified.
  • lastModified: AtBy!
  • # The name.
  • name: String!
  • # An Amazon Event Bridge cron expression (
  • # https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html#eb-cron-expressions
  • # )
  • scheduleExpression: String!
  • # A list of the Edges messages are sent on.
  • sendEdges: [Edge]
  • # The MessageType that this Node is capable of sending.
  • sendMessageType: MessageType
  • # Is the Node stopped; null == false.
  • stopped: Boolean
  • # The Tenant.
  • tenant: Tenant!
  • # Deletes this Node and all of its Edges.
  • #
  • # Arguments
  • # drainEdges: If sending Edges attached to this Nodes should be
  • # drained. Defaults to True.
  • Delete(drainEdges: Boolean): Boolean!
  • # Lists the changes.
  • #
  • # Arguments
  • # endDateTime: The end date/time (inclusive) to list changes for
  • # in ISO8601 format. Defaults to now.
  • # exclusiveStartKey: The lastEvaluatedKey from a previous
  • # ChangeResult. Used when paginating.
  • # limit: Used for limiting the number of results when paginating.
  • # Defaults to "all".
  • # sortAscending: True for ascending results, False for descending
  • # result. Defaults to True.
  • # startDateTime: The start date/time (inclusive) to list changes
  • # for in ISO8601 format. Defaults to the beginning of time.
  • ListChanges(
  • endDateTime: AWSDateTime,
  • exclusiveStartKey: AWSJSON,
  • limit: Int,
  • sortAscending: Boolean,
  • startDateTime: AWSDateTime
  • ): ChangeResult!
  • # Starts a stopped Node. Has no effect on an already running Node.
  • Start: Boolean!
  • # Stops a running Node. Has no effect on an already stopped Node.
  • Stop: Boolean!
  • # Updates and returns the TimerNode.
  • #
  • # Arguments
  • # description: A human-readable description.
  • Update(description: String): TimerNode!
  • }