OBJECT

BitmapperFunction

Represents a bitmapper function in the Function library. BitmapperFunctions are used in RouterNodes.

link GraphQL Schema definition

  • type BitmapperFunction implements Function {
  • # The MessageType passed in to the Function.
  • argumentMessageType: MessageType!
  • # A Python code string that contains a single top-level function definition.
  • # This function must have the signature (*, context, message, source, **kwargs)
  • # and return an integer.
  • code: String!
  • # When and who created.
  • created: AtBy!
  • # A human-readable description.
  • description: String!
  • # True if this is used by other resources.
  • inUse: Boolean!
  • # When and who modified.
  • lastModified: AtBy!
  • # The name.
  • name: String!
  • # README in MarkDown format.
  • readme: String
  • # The list of Python requirements, in pip format.
  • requirements: [String!]
  • # True if this is an EchoStream system resource.
  • system: Boolean
  • # The Tenant.
  • tenant: Tenant
  • # Deletes this.
  • Delete: 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!
  • # Updates the Function. Note that all Nodes that use this Function may also be
  • # updated - see blow.
  • #
  • # Arguments
  • # code: A Python code string that contains a single top-level
  • # function definition.
  • # This function must have the signature (*, context, message, source, **kwargs)
  • # and return an integer.
  • # description: The description. Null is ignored.
  • # readme: The README. Must be in MarkDown format. Null removes
  • # the readme.
  • # The README in MarkDown format.
  • # requirements: The requirements. Each element must be in pip
  • # requirement format. Null or an empty list removes all requirements.
  • Update(
  • code: String,
  • description: String,
  • readme: String,
  • requirements: [String!]
  • ): BitmapperFunction!
  • # Validates the supplied code against the supplied message.
  • #
  • # Arguments
  • # code: The code to validate.
  • # message: The message to use for validation.
  • # loggingLevel: The loggingLevel to use during the validation.
  • # Defaults to INFO.
  • # source: The source "node" of the test message. Defaults to
  • # "Validation".
  • Validate(
  • code: String!,
  • message: String!,
  • loggingLevel: LogLevel,
  • source: String
  • ): ValidationResult!
  • }