JobVertexMessageParameters (Flink : Runtime 2.1.0 API)

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

Direct Known Subclasses:

JobVertexFlameGraphParameters, JobVertexMetricsMessageParameters, SubtaskMessageParameters
```
public class JobVertexMessageParameters
extends JobMessageParameters
```
Message parameters for job vertex REST handlers.

Field Summary

Fields
Modifier and Type Field Description

JobVertexIdPathParameter jobVertexIdPathParameter
- Fields inherited from class org.apache.flink.runtime.rest.messages.JobMessageParameters
  jobPathParameter

Constructor Summary

Constructors
Constructor Description

JobVertexMessageParameters()

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
  - jobVertexIdPathParameter
```
public final JobVertexIdPathParameter jobVertexIdPathParameter
```
- Constructor Detail
  - JobVertexMessageParameters
```
public JobVertexMessageParameters()
```
- 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.
    
    Overrides:
    
    getPathParameters in class JobMessageParameters
    
    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.
    
    Overrides:
    
    getQueryParameters in class JobMessageParameters
    
    Returns:
    
    collection of all supported message query parameters