JobMessageParameters (Flink : Runtime 2.1.0 API)

java.lang.Object
- org.apache.flink.runtime.rest.messages.MessageParameters
- - org.apache.flink.runtime.rest.messages.JobMessageParameters

Direct Known Subclasses:

CheckpointMessageParameters, JobAccumulatorsMessageParameters, JobExceptionsMessageParameters, JobMetricsMessageParameters, JobTaskManagerMessageParameters, JobVertexMessageParameters, RescalingStatusMessageParameters, RescalingTriggerMessageParameters
```
public class JobMessageParameters
extends MessageParameters
```
Message parameters which require a job path parameter.

Field Summary

Fields
Modifier and Type Field Description

JobIDPathParameter jobPathParameter

Constructor Summary

Constructors
Constructor Description

JobMessageParameters()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Collection<MessagePathParameter<?>>`	`getPathParameters()`	Returns the collection of `MessagePathParameter` that the request supports.
`Collection<MessageQueryParameter<?>>`	`getQueryParameters()`	Returns the collection of `MessageQueryParameter` that the request supports.

Methods inherited from class org.apache.flink.runtime.rest.messages.MessageParameters
isResolved, resolveUrl

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

- Field Detail
  - jobPathParameter
```
public final JobIDPathParameter jobPathParameter
```
- Constructor Detail
  - JobMessageParameters
```
public JobMessageParameters()
```
- Method Detail
  - getPathParameters
```
public Collection<MessagePathParameter<?>> getPathParameters()
```
    Description copied from class: MessageParameters
    
    Returns the collection of MessagePathParameter that the request supports. The collection should not be modifiable.
    
    Specified by:
    
    getPathParameters in class MessageParameters
    
    Returns:
    
    collection of all supported message path parameters
  - getQueryParameters
```
public Collection<MessageQueryParameter<?>> getQueryParameters()
```
    Description copied from class: MessageParameters
    
    Returns the collection of MessageQueryParameter that the request supports. The collection should not be modifiable.
    
    Specified by:
    
    getQueryParameters in class MessageParameters
    
    Returns:
    
    collection of all supported message query parameters