Interface RollUpDataPointsRequestOrBuilder (0.2.0) 

public interface RollUpDataPointsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataSourceFamily()

public abstract String getDataSourceFamily()

Optional. The data source family name to roll up.

If empty, data points from all available data sources will be rolled up.

Format: users/me/dataSourceFamilies/{data_source_family}

The supported values are:

  • users/me/dataSourceFamilies/all-sources - default value
  • users/me/dataSourceFamilies/google-wearables - tracker devices
  • users/me/dataSourceFamilies/google-sources - Google first party sources

string data_source_family = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The dataSourceFamily.

getDataSourceFamilyBytes()

public abstract ByteString getDataSourceFamilyBytes()

Optional. The data source family name to roll up.

If empty, data points from all available data sources will be rolled up.

Format: users/me/dataSourceFamilies/{data_source_family}

The supported values are:

  • users/me/dataSourceFamilies/all-sources - default value
  • users/me/dataSourceFamilies/google-wearables - tracker devices
  • users/me/dataSourceFamilies/google-sources - Google first party sources

string data_source_family = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for dataSourceFamily.

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly.

int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.

string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.

string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. Parent data type of the Data Point collection.

Format: users/{user}/dataTypes/{data_type}, e.g.:

  • users/me/dataTypes/steps

  • users/me/dataTypes/distance

    For a list of the supported data types see the RollupDataPoint value union field.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. Parent data type of the Data Point collection.

Format: users/{user}/dataTypes/{data_type}, e.g.:

  • users/me/dataTypes/steps

  • users/me/dataTypes/distance

    For a list of the supported data types see the RollupDataPoint value union field.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getRange()

public abstract Interval getRange()

Required. Closed-open range of data points that will be rolled up. The maximum range for calories-in-heart-rate-zone, heart-rate, active-minutes and total-calories is 14 days. The maximum range for all other data types is 90 days.

.google.type.Interval range = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.Interval

The range.

getRangeOrBuilder()

public abstract IntervalOrBuilder getRangeOrBuilder()

Required. Closed-open range of data points that will be rolled up. The maximum range for calories-in-heart-rate-zone, heart-rate, active-minutes and total-calories is 14 days. The maximum range for all other data types is 90 days.

.google.type.Interval range = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.IntervalOrBuilder

getWindowSize()

public abstract Duration getWindowSize()

Required. The size of the time window to group data points into before applying the aggregation functions.

.google.protobuf.Duration window_size = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The windowSize.

getWindowSizeOrBuilder()

public abstract DurationOrBuilder getWindowSizeOrBuilder()

Required. The size of the time window to group data points into before applying the aggregation functions.

.google.protobuf.Duration window_size = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

hasRange()

public abstract boolean hasRange()

Required. Closed-open range of data points that will be rolled up. The maximum range for calories-in-heart-rate-zone, heart-rate, active-minutes and total-calories is 14 days. The maximum range for all other data types is 90 days.

.google.type.Interval range = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the range field is set.

hasWindowSize()

public abstract boolean hasWindowSize()

Required. The size of the time window to group data points into before applying the aggregation functions.

.google.protobuf.Duration window_size = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the windowSize field is set.