org.apache.flink.runtime.rest.messages.job

Class JobSubmitHeaders

java.lang.Object

org.apache.flink.runtime.rest.messages.job.JobSubmitHeaders

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<JobSubmitRequestBody,JobSubmitResponseBody,EmptyMessageParameters>, RuntimeMessageHeaders<JobSubmitRequestBody,JobSubmitResponseBody,EmptyMessageParameters>, UntypedResponseMessageHeaders<JobSubmitRequestBody,EmptyMessageParameters>

public class JobSubmitHeaders
extends Object
implements RuntimeMessageHeaders<JobSubmitRequestBody,JobSubmitResponseBody,EmptyMessageParameters>

These headers define the protocol for submitting a job to a flink cluster.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsFileUploads() Returns whether this header allows file uploads.
String	getDescription() Returns the description for this header.
HttpMethodWrapper	getHttpMethod() Returns the HttpMethodWrapper to be used for the request.
static JobSubmitHeaders	getInstance()
Class<JobSubmitRequestBody>	getRequestClass() Returns the class of the request message.
Class<JobSubmitResponseBody>	getResponseClass() Returns the class of the response message.
org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus	getResponseStatusCode() Returns the http status code for the response.
String	getTargetRestEndpointURL() Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.
EmptyMessageParameters	getUnresolvedMessageParameters() Returns a new MessageParameters object.
String	operationId() Returns a short description for this header suitable for method code generation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.runtime.rest.messages.RuntimeMessageHeaders

getSupportedAPIVersions

Methods inherited from interface org.apache.flink.runtime.rest.messages.MessageHeaders

getCustomHeaders, getResponseTypeParameters

Method Detail

getRequestClass

public Class<JobSubmitRequestBody> getRequestClass()

Description copied from interface: UntypedResponseMessageHeaders

Returns the class of the request message.

Specified by:

getRequestClass in interface UntypedResponseMessageHeaders<JobSubmitRequestBody,EmptyMessageParameters>

Returns:

class of the request message

getHttpMethod

public HttpMethodWrapper getHttpMethod()

Description copied from interface: RestHandlerSpecification

Returns the HttpMethodWrapper to be used for the request.

Specified by:

getHttpMethod in interface RestHandlerSpecification

Returns:

http method to be used for the request

getTargetRestEndpointURL

public String getTargetRestEndpointURL()

Description copied from interface: RestHandlerSpecification

Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.

Specified by:

getTargetRestEndpointURL in interface RestHandlerSpecification

Returns:

endpoint url that this request should be sent to

getResponseClass

public Class<JobSubmitResponseBody> getResponseClass()

Description copied from interface: MessageHeaders

Returns the class of the response message.

Specified by:

getResponseClass in interface MessageHeaders<JobSubmitRequestBody,JobSubmitResponseBody,EmptyMessageParameters>

Returns:

class of the response message

getResponseStatusCode

public org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus getResponseStatusCode()

Description copied from interface: MessageHeaders

Returns the http status code for the response.

Specified by:

getResponseStatusCode in interface MessageHeaders<JobSubmitRequestBody,JobSubmitResponseBody,EmptyMessageParameters>

Returns:

http status code of the response

getUnresolvedMessageParameters

public EmptyMessageParameters getUnresolvedMessageParameters()

Description copied from interface: UntypedResponseMessageHeaders

Returns a new MessageParameters object.

Specified by:

getUnresolvedMessageParameters in interface UntypedResponseMessageHeaders<JobSubmitRequestBody,EmptyMessageParameters>

Returns:

new message parameters object

getInstance

public static JobSubmitHeaders getInstance()

getDescription

public String getDescription()

Description copied from interface: MessageHeaders

Returns the description for this header.

Specified by:

getDescription in interface MessageHeaders<JobSubmitRequestBody,JobSubmitResponseBody,EmptyMessageParameters>

Returns:

description for the header

acceptsFileUploads

public boolean acceptsFileUploads()

Description copied from interface: UntypedResponseMessageHeaders

Returns whether this header allows file uploads.

Specified by:

acceptsFileUploads in interface UntypedResponseMessageHeaders<JobSubmitRequestBody,EmptyMessageParameters>

Returns:

whether this header allows file uploads

operationId

public String operationId()

Description copied from interface: MessageHeaders

Returns a short description for this header suitable for method code generation.

Specified by:

operationId in interface MessageHeaders<JobSubmitRequestBody,JobSubmitResponseBody,EmptyMessageParameters>

Returns:

short description