org.springframework.cloud.dataflow.shell.command.common

Class AggregateCounterCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.common.AbstractMetricsCommands

org.springframework.cloud.dataflow.shell.command.common.AggregateCounterCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

@Component
public class AggregateCounterCommands
extends AbstractMetricsCommands
implements org.springframework.shell.core.CommandMarker

Commands for interacting with aggregate counter analytics.

Author:

Ilayaperumal Gopinathan, Gunnar Hillert

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETE_AGGR_COUNTER
static String	DISPLAY_AGGR_COUNTER
static String	LIST_AGGR_COUNTERS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggregateCounterCommands()

Method Summary

Modifier and Type	Method and Description
boolean	availableWithCreateRole()
boolean	availableWithViewRole()
String	delete(String name)
org.springframework.shell.table.Table	display(String name, String from, String to, Integer lastHours, Integer lastDays, AggregateCounterOperations.Resolution resolution, NumberFormat pattern)
org.springframework.shell.table.Table	list()

Methods inherited from class org.springframework.cloud.dataflow.shell.command.common.AbstractMetricsCommands

displayMetrics

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_AGGR_COUNTER

public static final String DISPLAY_AGGR_COUNTER

See Also:

Constant Field Values

LIST_AGGR_COUNTERS

public static final String LIST_AGGR_COUNTERS

See Also:

Constant Field Values

DELETE_AGGR_COUNTER

public static final String DELETE_AGGR_COUNTER

See Also:

Constant Field Values

Constructor Detail

AggregateCounterCommands

protected AggregateCounterCommands()

Method Detail

availableWithViewRole

@CliAvailabilityIndicator(value={"aggregate-counter display","aggregate-counter list"})
public boolean availableWithViewRole()

availableWithCreateRole

@CliAvailabilityIndicator(value="aggregate-counter delete")
public boolean availableWithCreateRole()

display

@CliCommand(value="aggregate-counter display",
            help="Display aggregate counter values by chosen interval and resolution(minute, hour)")
public org.springframework.shell.table.Table display(@CliOption(optionContext="existing-aggregate-counter disable-string-converter",key={"","name"},help="the name of the aggregate counter to display",mandatory=true)
                                                                                                                                                                                                         String name,
                                                                                                                                                                                                         @CliOption(key="from",help="start-time for the interval. format: \'yyyy-MM-dd HH:mm:ss\'",mandatory=false)
                                                                                                                                                                                                         String from,
                                                                                                                                                                                                         @CliOption(key="to",help="end-time for the interval. format: \'yyyy-MM-dd HH:mm:ss\'. defaults to now",mandatory=false)
                                                                                                                                                                                                         String to,
                                                                                                                                                                                                         @CliOption(key="lastHours",help="set the interval to last \'n\' hours",mandatory=false)
                                                                                                                                                                                                         Integer lastHours,
                                                                                                                                                                                                         @CliOption(key="lastDays",help="set the interval to last \'n\' days",mandatory=false)
                                                                                                                                                                                                         Integer lastDays,
                                                                                                                                                                                                         @CliOption(key="resolution",help="the size of the bucket to aggregate (minute, hour, day, month)",mandatory=false,unspecifiedDefaultValue="hour")
                                                                                                                                                                                                         AggregateCounterOperations.Resolution resolution,
                                                                                                                                                                                                         @CliOption(key="pattern",help="the pattern used to format the count values (see DecimalFormat)",mandatory=false,unspecifiedDefaultValue="<use platform locale>")
                                                                                                                                                                                                         NumberFormat pattern)

list

@CliCommand(value="aggregate-counter list",
            help="List all available aggregate counter names")
public org.springframework.shell.table.Table list()

delete

@CliCommand(value="aggregate-counter delete",
            help="Delete an aggregate counter")
public String delete(@CliOption(key={"","name"},help="the name of the aggregate counter to delete",mandatory=true,optionContext="existing-aggregate-counter disable-string-converter")
                                                                                                                   String name)