Class DailyRollUpDataPointsRequest.Builder (0.8.0) 

public static final class DailyRollUpDataPointsRequest.Builder extends GeneratedMessage.Builder<DailyRollUpDataPointsRequest.Builder> implements DailyRollUpDataPointsRequestOrBuilder

Request to roll up data points by civil time intervals.

Protobuf type google.devicesandservices.health.v4.DailyRollUpDataPointsRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

build()

public DailyRollUpDataPointsRequest build()
Returns
Type Description
DailyRollUpDataPointsRequest

buildPartial()

public DailyRollUpDataPointsRequest buildPartial()
Returns
Type Description
DailyRollUpDataPointsRequest

clear()

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

clearDataSourceFamily()

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

This builder for chaining.

clearPageSize()

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

This builder for chaining.

clearPageToken()

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

This builder for chaining.

clearParent()

public DailyRollUpDataPointsRequest.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 DailyRollupDataPoint value union field.

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

Returns
Type Description
DailyRollUpDataPointsRequest.Builder

This builder for chaining.

clearRange()

public DailyRollUpDataPointsRequest.Builder clearRange()

Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. 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.devicesandservices.health.v4.CivilTimeInterval range = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DailyRollUpDataPointsRequest.Builder

clearWindowSizeDays()

public DailyRollUpDataPointsRequest.Builder clearWindowSizeDays()

Optional. Aggregation window size, in number of days. Defaults to 1 if not specified.

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

int32 window_size_days = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DailyRollUpDataPointsRequest.Builder

This builder for chaining.

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 DailyRollUpDataPointsRequest getDefaultInstanceForType()
Returns
Type Description
DailyRollUpDataPointsRequest

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 DailyRollupDataPoint 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 DailyRollupDataPoint 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 CivilTimeInterval getRange()

Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. 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.devicesandservices.health.v4.CivilTimeInterval range = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CivilTimeInterval

The range.

getRangeBuilder()

public CivilTimeInterval.Builder getRangeBuilder()

Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. 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.devicesandservices.health.v4.CivilTimeInterval range = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CivilTimeInterval.Builder

getRangeOrBuilder()

public CivilTimeIntervalOrBuilder getRangeOrBuilder()

Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. 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.devicesandservices.health.v4.CivilTimeInterval range = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CivilTimeIntervalOrBuilder

getWindowSizeDays()

public int getWindowSizeDays()

Optional. Aggregation window size, in number of days. Defaults to 1 if not specified.

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

int32 window_size_days = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The windowSizeDays.

hasRange()

public boolean hasRange()

Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. 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.devicesandservices.health.v4.CivilTimeInterval range = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the range field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DailyRollUpDataPointsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRange(CivilTimeInterval value)

public DailyRollUpDataPointsRequest.Builder mergeRange(CivilTimeInterval value)

Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. 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.devicesandservices.health.v4.CivilTimeInterval range = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CivilTimeInterval
Returns
Type Description
DailyRollUpDataPointsRequest.Builder

setDataSourceFamily(String value)

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

This builder for chaining.

setDataSourceFamilyBytes(ByteString value)

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

This builder for chaining.

setPageSize(int value)

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

This builder for chaining.

setPageToken(String value)

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

This builder for chaining.

setPageTokenBytes(ByteString value)

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

This builder for chaining.

setParent(String value)

public DailyRollUpDataPointsRequest.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 DailyRollupDataPoint 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
DailyRollUpDataPointsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public DailyRollUpDataPointsRequest.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 DailyRollupDataPoint 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
DailyRollUpDataPointsRequest.Builder

This builder for chaining.

setRange(CivilTimeInterval value)

public DailyRollUpDataPointsRequest.Builder setRange(CivilTimeInterval value)

Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. 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.devicesandservices.health.v4.CivilTimeInterval range = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CivilTimeInterval
Returns
Type Description
DailyRollUpDataPointsRequest.Builder

setRange(CivilTimeInterval.Builder builderForValue)

public DailyRollUpDataPointsRequest.Builder setRange(CivilTimeInterval.Builder builderForValue)

Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. 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.devicesandservices.health.v4.CivilTimeInterval range = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue CivilTimeInterval.Builder
Returns
Type Description
DailyRollUpDataPointsRequest.Builder

setWindowSizeDays(int value)

public DailyRollUpDataPointsRequest.Builder setWindowSizeDays(int value)

Optional. Aggregation window size, in number of days. Defaults to 1 if not specified.

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

int32 window_size_days = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The windowSizeDays to set.
Returns
Type Description
DailyRollUpDataPointsRequest.Builder

This builder for chaining.