org.springframework.xd.shell.command

Class AggregateCounterCommands

java.lang.Object

org.springframework.xd.shell.command.AbstractMetricsCommands

org.springframework.xd.shell.command.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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggregateCounterCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
java.lang.String	delete(java.lang.String name)
Table	display(java.lang.String name, java.lang.String from, java.lang.String to, java.lang.Integer lastHours, java.lang.Integer lastDays, AggregateCounterOperations.Resolution resolution, java.text.NumberFormat pattern)
Table	list()

Methods inherited from class org.springframework.xd.shell.command.AbstractMetricsCommands

displayMetrics

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateCounterCommands

protected AggregateCounterCommands()

Method Detail

available

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

display

@CliCommand(value="aggregate-counter display",
            help="Display aggregate counter values by chosen interval and resolution(minute, hour)")
public Table display(@CliOption(key={"","name"},help="the name of the aggregate counter to display",mandatory=true,optionContext="existing-aggregate-counter disable-string-converter")
                       java.lang.String name,
                       @CliOption(key="from",help="start-time for the interval. format: \'yyyy-MM-dd HH:mm:ss\'",mandatory=false)
                       java.lang.String from,
                       @CliOption(key="to",help="end-time for the interval. format: \'yyyy-MM-dd HH:mm:ss\'. defaults to now",mandatory=false)
                       java.lang.String to,
                       @CliOption(key="lastHours",help="set the interval to last \'n\' hours",mandatory=false)
                       java.lang.Integer lastHours,
                       @CliOption(key="lastDays",help="set the interval to last \'n\' days",mandatory=false)
                       java.lang.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="")
                       java.text.NumberFormat pattern)

list

@CliCommand(value="aggregate-counter list",
            help="List all available aggregate counter names")
public Table list()

delete

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