Package org.springframework.cloud.dataflow.rest.client

Interface RuntimeOperations

All Known Implementing Classes:
RuntimeTemplate
public interface RuntimeOperations
Defines operations available for obtaining information about deployed apps.
Author:
Eric Bottard, Mark Fisher, Chris Bono, Corneil du Plessis

  • Method Details

    • status

      org.springframework.hateoas.PagedModel<AppStatusResource> status()
      Returns:
      the runtime information about all deployed apps.

    • status

      AppStatusResource status(String deploymentId)
      Parameters:
      deploymentId - the deployment id
      Returns:
      the runtime information about a single app deployment.

    • streamStatus

      org.springframework.hateoas.PagedModel<StreamStatusResource> streamStatus(String... streamNames)
      Parameters:
      streamNames - deployed stream names
      Returns:
      the runtime information about the deployed streams their apps and instances.

    • getFromActuator

      String getFromActuator(String appId, String instanceId, String endpoint)
      Access an HTTP GET exposed actuator resource for a deployed app instance.
      Parameters:
      appId - the application id
      instanceId - the application instance id
      endpoint - the relative actuator path, e.g., /info
      Returns:
      the contents as JSON text

    • postToActuator

      Object postToActuator(String appId, String instanceId, String endpoint, Map<String,Object> data)
      Access an HTTP POST exposed actuator resource for a deployed app instance.
      Parameters:
      appId - the application id
      instanceId - the application instance id
      endpoint - the relative actuator path, e.g., /info
      data - map representing the data to post on request body
      Returns:
      response from actuator

    • postToUrl

      void postToUrl(String appId, String instanceId, byte[] data, HttpHeaders headers)
      Provides for POST to application HTTP endpoint exposed via url property.
      Parameters:
      appId - the application id
      instanceId - the application instance id
      data - data to send to url. The mimetype should be in the Content-Type header if important.
      headers - post request headers. This method will return an exception