io.cdap.plugin.hubspot.common

Enum TimePeriod

java.lang.Object

java.lang.Enum<TimePeriod>

io.cdap.plugin.hubspot.common.TimePeriod

All Implemented Interfaces:

Serializable, Comparable<TimePeriod>

public enum TimePeriod
extends Enum<TimePeriod>

Convenience enum to map TimePeriod UI selections to meaningful values. The time period used to group the data. Must be one of:

total - Data is rolled up to totals covering the specified time. daily - Grouped by day weekly - Grouped by week monthly - Grouped by month summarize/daily - Grouped by day, data is rolled up across all breakdowns summarize/weekly - Grouped by week, data is rolled up across all breakdowns summarize/monthly - Grouped by month, data is rolled up across all breakdowns NOTE: When using daily, weekly, or monthly for the time_period, you must include at least one filter

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAILY
MONTHLY
SUMMARIZE_DAILY
SUMMARIZE_MONTHLY
SUMMARIZE_WEEKLY
TOTAL
WEEKLY

Method Summary

Modifier and Type	Method and Description
static TimePeriod	fromString(String value) Returns the TimePeriod.
String	getStringValue()
static TimePeriod	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimePeriod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOTAL

public static final TimePeriod TOTAL

DAILY

public static final TimePeriod DAILY

WEEKLY

public static final TimePeriod WEEKLY

MONTHLY

public static final TimePeriod MONTHLY

SUMMARIZE_DAILY

public static final TimePeriod SUMMARIZE_DAILY

SUMMARIZE_WEEKLY

public static final TimePeriod SUMMARIZE_WEEKLY

SUMMARIZE_MONTHLY

public static final TimePeriod SUMMARIZE_MONTHLY

Method Detail

values

public static TimePeriod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TimePeriod c : TimePeriod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimePeriod valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static TimePeriod fromString(String value)

Returns the TimePeriod.

Parameters:

value - the value is string type

Returns:

the TimePeriod

getStringValue

public String getStringValue()