Class RollUpDataPointsRequest.Builder (0.8.0) 

public static final class RollUpDataPointsRequest.Builder extends GeneratedMessage.Builder<RollUpDataPointsRequest.Builder> implements RollUpDataPointsRequestOrBuilder

Request to roll up data points by physical time intervals.

Protobuf type google.devicesandservices.health.v4.RollUpDataPointsRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > RollUpDataPointsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public RollUpDataPointsRequest build()
Returns
Type Description
RollUpDataPointsRequest

buildPartial()

public RollUpDataPointsRequest buildPartial()
Returns
Type Description
RollUpDataPointsRequest

clear()

public RollUpDataPointsRequest.Builder clear()
Returns
Type Description
RollUpDataPointsRequest.Builder
Overrides

clearDataSourceFamily()

public RollUpDataPointsRequest.Builder clearDataSourceFamily()

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. Includes data from all available data sources.
  • users/me/dataSourceFamilies/google-wearables - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data.
  • users/me/dataSourceFamilies/google-sources - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.

  • users/me/dataSourceFamilies/self-sources - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller.

    Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to self-sources, and requesting any other data source family fails with PERMISSION_DENIED.

    If no data point matches the requested data source family, the response is an empty list rather than an error.

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

Returns
Type Description
RollUpDataPointsRequest.Builder

This builder for chaining.

clearPageSize()

public RollUpDataPointsRequest.Builder clearPageSize()

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
RollUpDataPointsRequest.Builder

This builder for chaining.

clearPageToken()

public RollUpDataPointsRequest.Builder clearPageToken()

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
RollUpDataPointsRequest.Builder

This builder for chaining.

clearParent()

public RollUpDataPointsRequest.Builder clearParent()

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
RollUpDataPointsRequest.Builder

This builder for chaining.

clearRange()

public RollUpDataPointsRequest.Builder clearRange()

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
RollUpDataPointsRequest.Builder

clearWindowSize()

public RollUpDataPointsRequest.Builder clearWindowSize()

Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.

If the requested range is not an exact multiple of window_size, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than window_size.

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

Returns
Type Description
RollUpDataPointsRequest.Builder

getDataSourceFamily()

public 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. Includes data from all available data sources.
  • users/me/dataSourceFamilies/google-wearables - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data.
  • users/me/dataSourceFamilies/google-sources - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.

  • users/me/dataSourceFamilies/self-sources - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller.

    Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to self-sources, and requesting any other data source family fails with PERMISSION_DENIED.

    If no data point matches the requested data source family, the response is an empty list rather than an error.

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

Returns
Type Description
String

The dataSourceFamily.

getDataSourceFamilyBytes()

public 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. Includes data from all available data sources.
  • users/me/dataSourceFamilies/google-wearables - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data.
  • users/me/dataSourceFamilies/google-sources - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.

  • users/me/dataSourceFamilies/self-sources - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller.

    Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to self-sources, and requesting any other data source family fails with PERMISSION_DENIED.

    If no data point matches the requested data source family, the response is an empty list rather than an error.

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

Returns
Type Description
ByteString

The bytes for dataSourceFamily.

getDefaultInstanceForType()

public RollUpDataPointsRequest getDefaultInstanceForType()
Returns
Type Description
RollUpDataPointsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public 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 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 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 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 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 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.

getRangeBuilder()

public Interval.Builder getRangeBuilder()

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.Builder

getRangeOrBuilder()

public 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 Duration getWindowSize()

Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.

If the requested range is not an exact multiple of window_size, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than window_size.

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

Returns
Type Description
Duration

The windowSize.

getWindowSizeBuilder()

public Duration.Builder getWindowSizeBuilder()

Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.

If the requested range is not an exact multiple of window_size, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than window_size.

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

Returns
Type Description
Builder

getWindowSizeOrBuilder()

public DurationOrBuilder getWindowSizeOrBuilder()

Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.

If the requested range is not an exact multiple of window_size, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than window_size.

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

Returns
Type Description
DurationOrBuilder

hasRange()

public 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 boolean hasWindowSize()

Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.

If the requested range is not an exact multiple of window_size, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than window_size.

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

Returns
Type Description
boolean

Whether the windowSize field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RollUpDataPointsRequest other)

public RollUpDataPointsRequest.Builder mergeFrom(RollUpDataPointsRequest other)
Parameter
Name Description
other RollUpDataPointsRequest
Returns
Type Description
RollUpDataPointsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RollUpDataPointsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RollUpDataPointsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RollUpDataPointsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RollUpDataPointsRequest.Builder
Overrides

mergeRange(Interval value)

public RollUpDataPointsRequest.Builder mergeRange(Interval value)

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];

Parameter
Name Description
value com.google.type.Interval
Returns
Type Description
RollUpDataPointsRequest.Builder

mergeWindowSize(Duration value)

public RollUpDataPointsRequest.Builder mergeWindowSize(Duration value)

Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.

If the requested range is not an exact multiple of window_size, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than window_size.

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

Parameter
Name Description
value Duration
Returns
Type Description
RollUpDataPointsRequest.Builder

setDataSourceFamily(String value)

public RollUpDataPointsRequest.Builder setDataSourceFamily(String value)

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. Includes data from all available data sources.
  • users/me/dataSourceFamilies/google-wearables - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data.
  • users/me/dataSourceFamilies/google-sources - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.

  • users/me/dataSourceFamilies/self-sources - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller.

    Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to self-sources, and requesting any other data source family fails with PERMISSION_DENIED.

    If no data point matches the requested data source family, the response is an empty list rather than an error.

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

Parameter
Name Description
value String

The dataSourceFamily to set.
Returns
Type Description
RollUpDataPointsRequest.Builder

This builder for chaining.

setDataSourceFamilyBytes(ByteString value)

public RollUpDataPointsRequest.Builder setDataSourceFamilyBytes(ByteString value)

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. Includes data from all available data sources.
  • users/me/dataSourceFamilies/google-wearables - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data.
  • users/me/dataSourceFamilies/google-sources - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect.

  • users/me/dataSourceFamilies/self-sources - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller.

    Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to self-sources, and requesting any other data source family fails with PERMISSION_DENIED.

    If no data point matches the requested data source family, the response is an empty list rather than an error.

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

Parameter
Name Description
value ByteString

The bytes for dataSourceFamily to set.
Returns
Type Description
RollUpDataPointsRequest.Builder

This builder for chaining.

setPageSize(int value)

public RollUpDataPointsRequest.Builder setPageSize(int value)

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];

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
RollUpDataPointsRequest.Builder

This builder for chaining.

setPageToken(String value)

public RollUpDataPointsRequest.Builder setPageToken(String value)

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];

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
RollUpDataPointsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public RollUpDataPointsRequest.Builder setPageTokenBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
RollUpDataPointsRequest.Builder

This builder for chaining.

setParent(String value)

public RollUpDataPointsRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
RollUpDataPointsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public RollUpDataPointsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
RollUpDataPointsRequest.Builder

This builder for chaining.

setRange(Interval value)

public RollUpDataPointsRequest.Builder setRange(Interval value)

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];

Parameter
Name Description
value com.google.type.Interval
Returns
Type Description
RollUpDataPointsRequest.Builder

setRange(Interval.Builder builderForValue)

public RollUpDataPointsRequest.Builder setRange(Interval.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.type.Interval.Builder
Returns
Type Description
RollUpDataPointsRequest.Builder

setWindowSize(Duration value)

public RollUpDataPointsRequest.Builder setWindowSize(Duration value)

Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.

If the requested range is not an exact multiple of window_size, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than window_size.

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

Parameter
Name Description
value Duration
Returns
Type Description
RollUpDataPointsRequest.Builder

setWindowSize(Duration.Builder builderForValue)

public RollUpDataPointsRequest.Builder setWindowSize(Duration.Builder builderForValue)

Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.

If the requested range is not an exact multiple of window_size, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than window_size.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RollUpDataPointsRequest.Builder