Interface Payload


  • public interface Payload
    Payload type with enhanced functionality. To use this functionality, your probe method must return instances of this type instead of String, declare a parameter with type ProbeContext to get a context instance and call ProbeContext.createPayload(String, Object, Enum) to create a payload that it can return.

    Do not create your own subtypes.

    • Method Detail

      • getName

        java.lang.String getName()
        The name for this payload.
        Returns:
        the name or null if none was provided yet
      • getEventType

        java.lang.Enum<?> getEventType()
        The type of the payload. One of the enum constants of Probe.customTypes().
        Returns:
        the type or null if none was provided
      • getControlObject

        java.lang.Object getControlObject()
        The control object for this payload.
        Returns:
        the control object or null if none was provided