StreamProbe (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- org.nuxeo.runtime.stream.StreamProbe

All Implemented Interfaces:

Probe
```
public class StreamProbe
extends Object
implements Probe
```
A probe to detect when computation has been terminated due to failure. A delay is applied before returning the failure code.

Since:

11.1

Field Summary

Fields
Modifier and Type	Field	Description
`protected Long`	`detected`
`protected static String`	`FAILURE_MESSAGE`
`protected static DateTimeFormatter`	`FORMATTER`
`protected io.dropwizard.metrics5.Counter`	`globalFailureCount`
`static Duration`	`STREAM_PROBE_DELAY_DEFAULT`
`static String`	`STREAM_PROBE_DELAY_PROPERTY`
`protected Duration`	`timeout`

Constructor Summary

Constructors
Constructor Description

StreamProbe()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected io.dropwizard.metrics5.Counter`	`getCounter()`
`protected long`	`getFailures()`
`protected Duration`	`getTimeout()`
`void`	`reset()`	Reset failure counter for testing purpose.
`ProbeStatus`	`run()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STREAM_PROBE_DELAY_PROPERTY

public static final String STREAM_PROBE_DELAY_PROPERTY

See Also:: Constant Field Values

STREAM_PROBE_DELAY_DEFAULT

public static final Duration STREAM_PROBE_DELAY_DEFAULT

FAILURE_MESSAGE

protected static final String FAILURE_MESSAGE

See Also:: Constant Field Values

globalFailureCount

protected io.dropwizard.metrics5.Counter globalFailureCount

detected
```
protected Long detected
```

timeout
```
protected Duration timeout
```

FORMATTER

protected static final DateTimeFormatter FORMATTER

Constructor Detail
- StreamProbe
```
public StreamProbe()
```

Method Detail

run
```
public ProbeStatus run()
```
Specified by:

run in interface Probe

getTimeout
```
protected Duration getTimeout()
```

getFailures
```
protected long getFailures()
```

getCounter

protected io.dropwizard.metrics5.Counter getCounter()

reset
```
public void reset()
```
Reset failure counter for testing purpose.

Since:

11.1