Package org.apache.flink.runtime.rest.messages

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

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.
JobCancellationMessageParameters	resolveJobId(org.apache.flink.api.common.JobID jobId)
JobCancellationMessageParameters	resolveTerminationMode(TerminationModeQueryParameter.TerminationMode terminationMode)

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

Constructor Details

JobCancellationMessageParameters

public JobCancellationMessageParameters()

Method Details

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

resolveJobId

public JobCancellationMessageParameters resolveJobId(org.apache.flink.api.common.JobID jobId)

resolveTerminationMode

public JobCancellationMessageParameters resolveTerminationMode(TerminationModeQueryParameter.TerminationMode terminationMode)