Class ViewData

java.lang.Object

io.opencensus.stats.ViewData

Direct Known Subclasses:

AutoValue_ViewData

@Immutable
public abstract class ViewData
extends Object

The aggregated data for a particular View.

Since:

0.8

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViewData.AggregationWindowData	Deprecated. since 0.13, please use start and end Timestamp instead.

Constructor Summary

Constructors

Constructor	Description
ViewData()

Method Summary

Modifier and Type	Method	Description
private static void	checkAggregation(Aggregation aggregation, AggregationData aggregationData, Measure measure)
private static void	checkWindow(View.AggregationWindow window, ViewData.AggregationWindowData windowData)
static ViewData	create(View view, Map<? extends List<TagValue>, ? extends AggregationData> map, Timestamp start, Timestamp end)	Constructs a new ViewData.
static ViewData	create(View view, Map<? extends List<TagValue>, ? extends AggregationData> map, ViewData.AggregationWindowData windowData)	Deprecated. in favor of create(View, Map, Timestamp, Timestamp).
private static String	createErrorMessageForAggregation(Aggregation aggregation, AggregationData aggregationData)
private static String	createErrorMessageForWindow(View.AggregationWindow window, ViewData.AggregationWindowData windowData)
private static ViewData	createInternal(View view, Map<List<TagValue>, AggregationData> aggregationMap, ViewData.AggregationWindowData window, Timestamp start, Timestamp end)
abstract Map<List<TagValue>, AggregationData>	getAggregationMap()	The AggregationData grouped by combination of tag values, associated with this ViewData.
abstract Timestamp	getEnd()	Returns the end Timestamp for a ViewData.
abstract Timestamp	getStart()	Returns the start Timestamp for a ViewData.
abstract View	getView()	The View associated with this ViewData.
abstract ViewData.AggregationWindowData	getWindowData()	Deprecated. in favor of getStart() and getEnd().
private static void	throwIfAggregationMismatch(boolean isValid, Aggregation aggregation, AggregationData aggregationData)
private static void	throwIfWindowMismatch(boolean isValid, View.AggregationWindow window, ViewData.AggregationWindowData windowData)

Methods inherited from class Object

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

Constructor Details

ViewData

ViewData()

Method Details

getView

public abstract View getView()

The View associated with this ViewData.

Since:

0.8

getAggregationMap

public abstract Map<List<TagValue>, AggregationData> getAggregationMap()

The AggregationData grouped by combination of tag values, associated with this ViewData.

Since:

0.8

getWindowData

@Deprecated
public abstract ViewData.AggregationWindowData getWindowData()

Deprecated.

in favor of getStart() and getEnd().

Returns the ViewData.AggregationWindowData associated with this ViewData.

ViewData.AggregationWindowData is deprecated since 0.13, please avoid using this method. Use getStart() and getEnd() instead.

Returns:

the AggregationWindowData.

Since:

0.8

getStart

public abstract Timestamp getStart()

Returns the start Timestamp for a ViewData.

Returns:

the start Timestamp.

Since:

0.13

getEnd

public abstract Timestamp getEnd()

Returns the end Timestamp for a ViewData.

Returns:

the end Timestamp.

Since:

0.13

create

@Deprecated
public static ViewData create(View view,
 Map<? extends List<TagValue>, ? extends AggregationData> map,
 ViewData.AggregationWindowData windowData)

Deprecated.

in favor of create(View, Map, Timestamp, Timestamp).

Constructs a new ViewData.

Parameters:

view - the View associated with this ViewData.

map - the mapping from TagValue list to AggregationData.

windowData - the ViewData.AggregationWindowData.

Returns:

a ViewData.

Throws:

IllegalArgumentException - if the types of Aggregation and AggregationData don't match, or the types of Window and WindowData don't match.

Since:

0.8

create

public static ViewData create(View view,
 Map<? extends List<TagValue>, ? extends AggregationData> map,
 Timestamp start,
 Timestamp end)

Constructs a new ViewData.

Parameters:

view - the View associated with this ViewData.

map - the mapping from TagValue list to AggregationData.

start - the start Timestamp for this ViewData.

end - the end Timestamp for this ViewData.

Returns:

a ViewData.

Throws:

IllegalArgumentException - if the types of Aggregation and AggregationData don't match.

Since:

0.13

createInternal

private static ViewData createInternal(View view,
 Map<List<TagValue>, AggregationData> aggregationMap,
 ViewData.AggregationWindowData window,
 Timestamp start,
 Timestamp end)

checkWindow

private static void checkWindow(View.AggregationWindow window,
 ViewData.AggregationWindowData windowData)

throwIfWindowMismatch

private static void throwIfWindowMismatch(boolean isValid,
 View.AggregationWindow window,
 ViewData.AggregationWindowData windowData)

createErrorMessageForWindow

private static String createErrorMessageForWindow(View.AggregationWindow window,
 ViewData.AggregationWindowData windowData)

checkAggregation

private static void checkAggregation(Aggregation aggregation,
 AggregationData aggregationData,
 Measure measure)

throwIfAggregationMismatch

private static void throwIfAggregationMismatch(boolean isValid,
 Aggregation aggregation,
 AggregationData aggregationData)

createErrorMessageForAggregation

private static String createErrorMessageForAggregation(Aggregation aggregation,
 AggregationData aggregationData)