org.apache.flink.runtime.rest.messages

Interface RequestBody

All Known Implementing Classes:

CheckpointTriggerRequestBody, ClientCoordinationRequestBody, EmptyRequestBody, JobClientHeartbeatRequestBody, JobResourceRequirementsBody, JobSubmitRequestBody, ProfilingRequestBody, SavepointDisposalRequest, SavepointTriggerRequestBody, StopWithSavepointRequestBody

public interface RequestBody

Marker interface for all requests of the REST API. This class represents the http body of a request.

Subclass instances are converted to JSON using jackson-databind. Subclasses must have a constructor that accepts all fields of the JSON request, that should be annotated with @JsonCreator.

All fields that should part of the JSON request must be accessible either by being public or having a getter.

When adding methods that are prefixed with get/is make sure to annotate them with @JsonIgnore.