com.opsmatters.bitly.api.model.v4

Class UnitQuery

java.lang.Object

com.opsmatters.bitly.api.model.v4.UnitQuery

public class UnitQuery
extends Object

Represents a query based on units.

Author:

Gerald Curley (opsmatters)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnitQuery.Builder Builder to make query construction easier.

Constructor Summary

Constructors

Constructor and Description
UnitQuery() Default constructor.

Method Summary

Modifier and Type	Method and Description
static UnitQuery.Builder	builder() Returns a builder for the query.
int	getSize() Returns the quantity of items to be returned.
Unit	getUnit() Returns the unit for the query (either "minute", "hour", "day", "week", "month").
String	getUnitReference() Returns the most recent time for to pull metrics for (ISO-8601 timestamp).
int	getUnits() Returns the units for the query.
void	setSize(int size) Sets the quantity of items to be returned.
void	setUnit(Unit unit) Sets the unit for the query (either "minute", "hour", "day", "week", "month").
void	setUnitReference(String unitReference) Sets the most recent time for to pull metrics for (ISO-8601 timestamp).
void	setUnits(int units) Sets the units for the query.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitQuery

public UnitQuery()

Default constructor.

Method Detail

getUnit

public Unit getUnit()

Returns the unit for the query (either "minute", "hour", "day", "week", "month").

Returns:

The unit for the query

setUnit

public void setUnit(Unit unit)

Sets the unit for the query (either "minute", "hour", "day", "week", "month").

Parameters:

unit - The unit for the query

getUnits

public int getUnits()

Returns the units for the query. A value of -1 returns all units available.

Returns:

The units for the query

setUnits

public void setUnits(int units)

Sets the units for the query. A value of -1 returns all units available.

Parameters:

units - The units for the query

getUnitReference

public String getUnitReference()

Returns the most recent time for to pull metrics for (ISO-8601 timestamp).

Returns:

The unit reference for the query

setUnitReference

public void setUnitReference(String unitReference)

Sets the most recent time for to pull metrics for (ISO-8601 timestamp). Defaults to current time.

Parameters:

unitReference - The unit reference for the query

getSize

public int getSize()

Returns the quantity of items to be returned.

Returns:

The size for the query

setSize

public void setSize(int size)

Sets the quantity of items to be returned. Defaults to 50.

Parameters:

size - The size for the query

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

builder

public static UnitQuery.Builder builder()

Returns a builder for the query.

Returns:

The builder instance.