Class JobCancellationMessageParameters
- java.lang.Object
-
- org.apache.flink.runtime.rest.messages.MessageParameters
-
- org.apache.flink.runtime.rest.messages.JobCancellationMessageParameters
-
public class JobCancellationMessageParameters extends MessageParameters
Parameters for job related REST handlers.A job related REST handler always requires a
JobIDPathParameter.
-
-
Constructor Summary
Constructors Constructor Description JobCancellationMessageParameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Collection<MessagePathParameter<?>>getPathParameters()Returns the collection ofMessagePathParameterthat the request supports.Collection<MessageQueryParameter<?>>getQueryParameters()Returns the collection ofMessageQueryParameterthat the request supports.JobCancellationMessageParametersresolveJobId(org.apache.flink.api.common.JobID jobId)JobCancellationMessageParametersresolveTerminationMode(TerminationModeQueryParameter.TerminationMode terminationMode)-
Methods inherited from class org.apache.flink.runtime.rest.messages.MessageParameters
isResolved, resolveUrl
-
-
-
-
Method Detail
-
getPathParameters
public Collection<MessagePathParameter<?>> getPathParameters()
Description copied from class:MessageParametersReturns the collection ofMessagePathParameterthat the request supports. The collection should not be modifiable.- Specified by:
getPathParametersin classMessageParameters- Returns:
- collection of all supported message path parameters
-
getQueryParameters
public Collection<MessageQueryParameter<?>> getQueryParameters()
Description copied from class:MessageParametersReturns the collection ofMessageQueryParameterthat the request supports. The collection should not be modifiable.- Specified by:
getQueryParametersin classMessageParameters- Returns:
- collection of all supported message query parameters
-
resolveJobId
public JobCancellationMessageParameters resolveJobId(org.apache.flink.api.common.JobID jobId)
-
resolveTerminationMode
public JobCancellationMessageParameters resolveTerminationMode(TerminationModeQueryParameter.TerminationMode terminationMode)
-
-