org.springframework.cloud.dataflow.shell.command

Class RuntimeCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.RuntimeCommands

@ShellComponent
public class RuntimeCommands
extends Object

Commands for displaying the runtime state of deployed apps.

Author:

Eric Bottard, Mark Fisher, Gunnar Hillert, Chris Bono

Constructor Summary

Constructors

Constructor and Description
RuntimeCommands(DataFlowShell dataFlowShell, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
org.springframework.shell.Availability	availableWithModifyRole()
org.springframework.shell.Availability	availableWithViewRole()
String	getFromActuator(String appId, String instanceId, String endpoint)
org.springframework.shell.table.Table	list(boolean summary, String[] appIds)
Object	postToActuator(String appId, String instanceId, String endpoint, String data)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuntimeCommands

public RuntimeCommands(DataFlowShell dataFlowShell,
                       com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

availableWithViewRole

public org.springframework.shell.Availability availableWithViewRole()

availableWithModifyRole

public org.springframework.shell.Availability availableWithModifyRole()

getFromActuator

@ShellMethod(key="runtime actuator get",
             value="Invoke actuator GET endpoint on app instance")
 @ShellMethodAvailability(value="availableWithViewRole")
public String getFromActuator(@ShellOption(value="--appId",help="app id of the app instance")
                                                                                                                                                                                                   String appId,
                                                                                                                                                                                                   @ShellOption(value="--instanceId",help="instance id of the app instance")
                                                                                                                                                                                                   String instanceId,
                                                                                                                                                                                                   @ShellOption(help="endpoint to invoke")
                                                                                                                                                                                                   String endpoint)

postToActuator

@ShellMethod(key="runtime actuator post",
             value="Invoke actuator POST endpoint on app instance")
 @ShellMethodAvailability(value="availableWithModifyRole")
public Object postToActuator(@ShellOption(value="--appId",help="app id of the app instance")
                                                                                                                                                                                                      String appId,
                                                                                                                                                                                                      @ShellOption(value="--instanceId",help="instance id of the app instance")
                                                                                                                                                                                                      String instanceId,
                                                                                                                                                                                                      @ShellOption(help="endpoint to invoke")
                                                                                                                                                                                                      String endpoint,
                                                                                                                                                                                                      @ShellOption(help="optional data to include in the request body in the form of a JSON string representing a Map<String, Object>",defaultValue="__NULL__")
                                                                                                                                                                                                      String data)

list

@ShellMethod(key="runtime apps",
             value="List runtime apps")
 @ShellMethodAvailability(value="availableWithViewRole")
public org.springframework.shell.table.Table list(@ShellOption(help="whether to hide app instance details",defaultValue="false")
                                                                                                                                                                                    boolean summary,
                                                                                                                                                                                    @ShellOption(value={"--appId","--appIds"},help="app id(s) to display, also supports \'<group>.*\' pattern",defaultValue="__NULL__")
                                                                                                                                                                                    String[] appIds)