GetOperationStatusHeaders (Flink : 2.0-preview1 API)

java.lang.Object
- org.apache.flink.table.gateway.rest.header.operation.AbstractOperationHeaders
- - org.apache.flink.table.gateway.rest.header.operation.GetOperationStatusHeaders

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>, UntypedResponseMessageHeaders<EmptyRequestBody,OperationMessageParameters>, SqlGatewayMessageHeaders<EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>
```
public class GetOperationStatusHeaders
extends AbstractOperationHeaders
```
Message headers for getting the status of operation.

Constructor Summary

Constructors
Constructor Description

GetOperationStatusHeaders()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDescription()`	Returns the description for this header.
`HttpMethodWrapper`	`getHttpMethod()`	Returns the `HttpMethodWrapper` to be used for the request.
`static GetOperationStatusHeaders`	`getInstance()`
`String`	`getTargetRestEndpointURL()`	Returns the generalized endpoint url that this request should be sent to, for example `/job/:jobid`.
`String`	`operationId()`	Returns a short description for this header suitable for method code generation.

Methods inherited from class org.apache.flink.table.gateway.rest.header.operation.AbstractOperationHeaders
getRequestClass, getResponseClass, getResponseStatusCode, getUnresolvedMessageParameters

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.MessageHeaders
getCustomHeaders, getResponseTypeParameters

Methods inherited from interface org.apache.flink.table.gateway.rest.header.SqlGatewayMessageHeaders
getSupportedAPIVersions

Methods inherited from interface org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders
acceptsFileUploads

- Constructor Detail
  - GetOperationStatusHeaders
```
public GetOperationStatusHeaders()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    Description copied from interface: MessageHeaders
    
    Returns the description for this header.
    
    Returns:
    
    description for the header
  - getHttpMethod
```
public HttpMethodWrapper getHttpMethod()
```
    Description copied from interface: RestHandlerSpecification
    
    Returns the HttpMethodWrapper to be used for the request.
    
    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.
    
    Returns:
    
    endpoint url that this request should be sent to
  - getInstance
```
public static GetOperationStatusHeaders getInstance()
```
  - operationId
```
public String operationId()
```
    Description copied from interface: MessageHeaders
    
    Returns a short description for this header suitable for method code generation.
    
    Returns:
    
    short description