ProbesObject (Nuxeo 2021.53.3 API Documentation)

java.lang.Object
- org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>
- - org.nuxeo.ecm.restapi.server.jaxrs.management.ProbesObject

All Implemented Interfaces:: Resource, Adaptable

public class ProbesObject
extends AbstractResource<ResourceTypeImpl>

Since:: 11.3

Field Summary
- Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
  ctx, next, path, prev, type

Constructor Summary

Constructors
Constructor Description

ProbesObject()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected ProbeInfo`	`checkProbe(String probeName, ProbeInfo probeInfo)`
`List<ProbeInfo>`	`doGet()`	Gets all the infos of all probes.
`ProbeInfo`	`doGet(String probeName)`	Gets the info of a specific probe.
`ProbeInfo`	`launch(String probeName)`	Launches a specific probe.

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, initialize, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

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

- Constructor Detail
  - ProbesObject
```
public ProbesObject()
```
- Method Detail
  - doGet
```
public ProbeInfo doGet(String probeName)
```
    Gets the info of a specific probe.
    
    Parameters:
    
    probeName - the shortcut name of the probe to get
    
    Returns:
    
    a ProbeInfo
  - doGet
```
public List<ProbeInfo> doGet()
```
    Gets all the infos of all probes.
    
    Returns:
    
    a list of all ProbeInfo
  - launch
```
public ProbeInfo launch(String probeName)
```
    Launches a specific probe.
    
    Parameters:
    
    probeName - the shortcut name of the probe to launch
    
    Returns:
    
    the result of the probe in a ProbeInfo
  - checkProbe
```
protected ProbeInfo checkProbe(String probeName,
                               ProbeInfo probeInfo)
```