com.hubspot.singularity.resources.StateResource Maven / Gradle / Ivy

Go to download
package com.hubspot.singularity.resources;

import com.google.inject.Inject;
import com.hubspot.singularity.SingularityState;
import com.hubspot.singularity.SingularityTaskReconciliationStatistics;
import com.hubspot.singularity.config.ApiPaths;
import com.hubspot.singularity.data.StateManager;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.tags.Tags;
import java.util.List;
import java.util.Optional;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;

@Path(ApiPaths.STATE_RESOURCE_PATH)
@Produces({ MediaType.APPLICATION_JSON })
@Schema(title = "Provides information about the current state of Singularity")
@Tags({ @Tag(name = "State") })
public class StateResource {
  private final StateManager stateManager;

  @Inject
  public StateResource(StateManager stateManager) {
    this.stateManager = stateManager;
  }

  @GET
  @Operation(summary = "Retrieve information about the current state of Singularity.")
  public SingularityState getState(
    @QueryParam("skipCache") boolean skipCache,
    @QueryParam("includeRequestIds") boolean includeRequestIds
  ) {
    return stateManager.getState(skipCache, includeRequestIds);
  }

  @GET
  @Path("/requests/under-provisioned")
  @Operation(summary = "Retrieve the list of under-provisioned request IDs.")
  public List getUnderProvisionedRequestIds(
    @QueryParam("skipCache") boolean skipCache
  ) {
    return stateManager.getState(skipCache, true).getUnderProvisionedRequestIds();
  }

  @GET
  @Path("/requests/over-provisioned")
  @Operation(summary = "Retrieve the list of over-provisioned request IDs.")
  public List getOverProvisionedRequestIds(
    @QueryParam("skipCache") boolean skipCache
  ) {
    return stateManager.getState(skipCache, true).getOverProvisionedRequestIds();
  }

  @GET
  @Path("/task-reconciliation")
  @Operation(
    summary = "Retrieve information about the most recent task reconciliation",
    responses = {
      @ApiResponse(
        responseCode = "404",
        description = "No reconciliation statistics are present"
      )
    }
  )
  public Optional getTaskReconciliationStatistics() {
    return stateManager.getTaskReconciliationStatistics();
  }
}