RpcRequest (OpenNMS 29.0.6 API)

All Known Implementing Classes:

CollectorRequestDTO, DetectorRequestDTO, DnsLookupRequestDTO, EchoRequest, PingRequestDTO, PingSweepRequestDTO, PollerRequestDTO, RequisitionRequestDTO, SnmpRequestDTO
```
public interface RpcRequest
```
The request of an RPC call.

Author:

jwhite

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`TAG_CLASS_NAME`
`static String`	`TAG_DESCRIPTION`
`static String`	`TAG_IP_ADDRESS`
`static String`	`TAG_NODE_ID`
`static String`	`TAG_NODE_LABEL`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getLocation()`	Used to route the request to the appropriate location.
`io.opentracing.Span`	`getSpan()`
`String`	`getSystemId()`	Used to route the request to a particular system at the given location.
`Long`	`getTimeToLiveMs()`	When using JMS, the request will fail if no response was received in this many milliseconds.
`Map<String,String>`	`getTracingInfo()`	RPC clients expose tracing info as tags there by giving more context to each RPC trace.

- Field Detail
  - TAG_NODE_ID
```
static final String TAG_NODE_ID
```
    See Also:
    
    Constant Field Values
  - TAG_NODE_LABEL
```
static final String TAG_NODE_LABEL
```
    See Also:
    
    Constant Field Values
  - TAG_CLASS_NAME
```
static final String TAG_CLASS_NAME
```
    See Also:
    
    Constant Field Values
  - TAG_IP_ADDRESS
```
static final String TAG_IP_ADDRESS
```
    See Also:
    
    Constant Field Values
  - TAG_DESCRIPTION
```
static final String TAG_DESCRIPTION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getLocation
```
String getLocation()
```
    Used to route the request to the appropriate location.
  - getSystemId
```
String getSystemId()
```
    Used to route the request to a particular system at the given location.
  - getTimeToLiveMs
```
Long getTimeToLiveMs()
```
    When using JMS, the request will fail if no response was received in this many milliseconds.
  - getTracingInfo
```
Map<String,String> getTracingInfo()
```
    RPC clients expose tracing info as tags there by giving more context to each RPC trace. Implementations should add tags defined above if they are available.
  - getSpan
```
io.opentracing.Span getSpan()
```