org.apache.flink.runtime.rest.messages

Interface ResponseBody

All Known Subinterfaces:

AsynchronouslyCreatedResource<T>

All Known Implementing Classes:

AggregatedMetricsResponseBody, AsynchronousOperationResult, CheckpointConfigInfo, CheckpointingStatistics, CheckpointStatistics, CheckpointStatistics.CompletedCheckpointStatistics, CheckpointStatistics.FailedCheckpointStatistics, CheckpointStatistics.PendingCheckpointStatistics, ClusterConfigurationInfo, ClusterOverviewWithVersion, DashboardConfiguration, EmptyResponseBody, ErrorResponseBody, JarListInfo, JarRunResponseBody, JarUploadResponseBody, JobAccumulatorsInfo, JobConfigInfo, JobDetailsInfo, JobExceptionsInfo, JobExecutionResultResponseBody, JobIdsWithStatusOverview, JobPlanInfo, JobSubmitResponseBody, JobVertexAccumulatorsInfo, JobVertexBackPressureInfo, JobVertexDetailsInfo, JobVertexTaskManagersInfo, MetricCollectionResponseBody, MultipleJobsDetails, SavepointInfo, SubtaskExecutionAttemptAccumulatorsInfo, SubtaskExecutionAttemptDetailsInfo, SubtasksAllAccumulatorsInfo, SubtasksTimesInfo, TaskCheckpointStatistics, TaskCheckpointStatisticsWithSubtaskDetails, TaskManagerDetailsInfo, TaskManagerInfo, TaskManagersInfo, TriggerResponse

public interface ResponseBody

Marker interface for all responses of the REST API. This class represents the http body of a response.

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

All fields that should part of the JSON response 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.