com.google.api.services.fitness.model

Class AggregateRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.fitness.model.AggregateRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AggregateRequest
extends GenericJson

Next id: 10

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Fitness API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AggregateRequest()

Method Summary

Modifier and Type	Method and Description
AggregateRequest	clone()
List<AggregateBy>	getAggregateBy() The specification of data to be aggregated.
BucketByActivity	getBucketByActivitySegment() Specifies that data be aggregated each activity segment recorded for a user.
BucketByActivity	getBucketByActivityType() Specifies that data be aggregated by the type of activity being performed when the data was recorded.
BucketBySession	getBucketBySession() Specifies that data be aggregated by user sessions.
BucketByTime	getBucketByTime() Specifies that data be aggregated by a single time interval.
Long	getEndTimeMillis() The end of a window of time.
List<String>	getFilteredDataQualityStandard() DO NOT POPULATE THIS FIELD.
Long	getStartTimeMillis() The start of a window of time.
AggregateRequest	set(String fieldName, Object value)
AggregateRequest	setAggregateBy(List<AggregateBy> aggregateBy) The specification of data to be aggregated.
AggregateRequest	setBucketByActivitySegment(BucketByActivity bucketByActivitySegment) Specifies that data be aggregated each activity segment recorded for a user.
AggregateRequest	setBucketByActivityType(BucketByActivity bucketByActivityType) Specifies that data be aggregated by the type of activity being performed when the data was recorded.
AggregateRequest	setBucketBySession(BucketBySession bucketBySession) Specifies that data be aggregated by user sessions.
AggregateRequest	setBucketByTime(BucketByTime bucketByTime) Specifies that data be aggregated by a single time interval.
AggregateRequest	setEndTimeMillis(Long endTimeMillis) The end of a window of time.
AggregateRequest	setFilteredDataQualityStandard(List<String> filteredDataQualityStandard) DO NOT POPULATE THIS FIELD.
AggregateRequest	setStartTimeMillis(Long startTimeMillis) The start of a window of time.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AggregateRequest

public AggregateRequest()

Method Detail

getAggregateBy

public List<AggregateBy> getAggregateBy()

The specification of data to be aggregated. At least one aggregateBy spec must be provided. All data that is specified will be aggregated using the same bucketing criteria. There will be one dataset in the response for every aggregateBy spec.

Returns:

value or null for none

setAggregateBy

public AggregateRequest setAggregateBy(List<AggregateBy> aggregateBy)

The specification of data to be aggregated. At least one aggregateBy spec must be provided. All data that is specified will be aggregated using the same bucketing criteria. There will be one dataset in the response for every aggregateBy spec.

Parameters:

aggregateBy - aggregateBy or null for none

getBucketByActivitySegment

public BucketByActivity getBucketByActivitySegment()

Specifies that data be aggregated each activity segment recorded for a user. Similar to bucketByActivitySegment, but bucketing is done for each activity segment rather than all segments of the same type. Mutually exclusive of other bucketing specifications.

Returns:

value or null for none

setBucketByActivitySegment

public AggregateRequest setBucketByActivitySegment(BucketByActivity bucketByActivitySegment)

Specifies that data be aggregated each activity segment recorded for a user. Similar to bucketByActivitySegment, but bucketing is done for each activity segment rather than all segments of the same type. Mutually exclusive of other bucketing specifications.

Parameters:

bucketByActivitySegment - bucketByActivitySegment or null for none

getBucketByActivityType

public BucketByActivity getBucketByActivityType()

Specifies that data be aggregated by the type of activity being performed when the data was recorded. All data that was recorded during a certain activity type (.for the given time range) will be aggregated into the same bucket. Data that was recorded while the user was not active will not be included in the response. Mutually exclusive of other bucketing specifications.

Returns:

value or null for none

setBucketByActivityType

public AggregateRequest setBucketByActivityType(BucketByActivity bucketByActivityType)

Specifies that data be aggregated by the type of activity being performed when the data was recorded. All data that was recorded during a certain activity type (.for the given time range) will be aggregated into the same bucket. Data that was recorded while the user was not active will not be included in the response. Mutually exclusive of other bucketing specifications.

Parameters:

bucketByActivityType - bucketByActivityType or null for none

getBucketBySession

public BucketBySession getBucketBySession()

Specifies that data be aggregated by user sessions. Data that does not fall within the time range of a session will not be included in the response. Mutually exclusive of other bucketing specifications.

Returns:

value or null for none

setBucketBySession

public AggregateRequest setBucketBySession(BucketBySession bucketBySession)

Specifies that data be aggregated by user sessions. Data that does not fall within the time range of a session will not be included in the response. Mutually exclusive of other bucketing specifications.

Parameters:

bucketBySession - bucketBySession or null for none

getBucketByTime

public BucketByTime getBucketByTime()

Specifies that data be aggregated by a single time interval. Mutually exclusive of other bucketing specifications.

Returns:

value or null for none

setBucketByTime

public AggregateRequest setBucketByTime(BucketByTime bucketByTime)

Specifies that data be aggregated by a single time interval. Mutually exclusive of other bucketing specifications.

Parameters:

bucketByTime - bucketByTime or null for none

getEndTimeMillis

public Long getEndTimeMillis()

The end of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive. The maximum allowed difference between start_time_millis // and end_time_millis is 7776000000 (roughly 90 days).

Returns:

value or null for none

setEndTimeMillis

public AggregateRequest setEndTimeMillis(Long endTimeMillis)

The end of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive. The maximum allowed difference between start_time_millis // and end_time_millis is 7776000000 (roughly 90 days).

Parameters:

endTimeMillis - endTimeMillis or null for none

getFilteredDataQualityStandard

public List<String> getFilteredDataQualityStandard()

DO NOT POPULATE THIS FIELD. It is ignored.

Returns:

value or null for none

setFilteredDataQualityStandard

public AggregateRequest setFilteredDataQualityStandard(List<String> filteredDataQualityStandard)

DO NOT POPULATE THIS FIELD. It is ignored.

Parameters:

filteredDataQualityStandard - filteredDataQualityStandard or null for none

getStartTimeMillis

public Long getStartTimeMillis()

The start of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive.

Returns:

value or null for none

setStartTimeMillis

public AggregateRequest setStartTimeMillis(Long startTimeMillis)

The start of a window of time. Data that intersects with this time window will be aggregated. The time is in milliseconds since epoch, inclusive.

Parameters:

startTimeMillis - startTimeMillis or null for none

set

public AggregateRequest set(String fieldName,
                            Object value)

Overrides:

set in class GenericJson

clone

public AggregateRequest clone()

Overrides:

clone in class GenericJson