Class ListDataPointsRequest.Builder (0.2.0)

public static final class ListDataPointsRequest.Builder extends GeneratedMessage.Builder<ListDataPointsRequest.Builder> implements ListDataPointsRequestOrBuilder

Request for listing raw data points

Protobuf type google.devicesandservices.health.v4.ListDataPointsRequest

Inheritance

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

Implements

ListDataPointsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public ListDataPointsRequest build()

Returns
Type	Description
ListDataPointsRequest

buildPartial()

public ListDataPointsRequest buildPartial()

Returns
Type	Description
ListDataPointsRequest

clear()

public ListDataPointsRequest.Builder clear()

Returns
Type	Description
ListDataPointsRequest.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearFilter()

public ListDataPointsRequest.Builder clearFilter()

Optional. Filter expression following https://google.aip.dev/160.

A time range (either physical or civil) can be specified.

The supported filter fields are:

• Interval start time:
• Pattern: {interval_data_type}.interval.start_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"

• distance.interval.start_time >= "2024-08-14T12:34:56Z"

• Interval civil start time:

• Pattern: {interval_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"

• distance.interval.civil_start_time >= "2024-08-14T12:34:56"

• Sample observation physical time:

• Pattern: {sample_data_type}.sample_time.physical_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"

• weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"

• Sample observation civil time:

• Pattern: {sample_data_type}.sample_time.civil_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"

• weight.sample_time.civil_time >= "2024-08-14T12:34:56"

• Daily summary date:

• Pattern: {daily_summary_data_type}.date
• Supported comparison operators: >=, <
• Date literal expected in ISO 8601 YYYY-MM-DD format
• Supported logical operators: AND
• Example:

• daily_heart_rate_variability.date < "2024-08-15"

• Session civil start time (Excluding Sleep and ECG):

• Pattern: {session_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"

• exercise.interval.civil_start_time >= "2024-08-14T12:34:56"

• Session start time (ECG specific):

• Pattern: electrocardiogram.interval.start_time
• Supported comparison operators: >=
• Timestamp literal expected in RFC-3339 format
• Example:
• electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"

• Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., electrocardiogram.interval.end_time) is not supported.

• Session end time (Sleep specific):

• Pattern: sleep.interval.end_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND, OR
• Example:

• sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"

• Session civil end time (Sleep specific):

• Pattern: sleep.interval.civil_end_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND, OR
• Example:
• sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"

Data points in the response will be ordered by the interval start time in descending order.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ListDataPointsRequest.Builder	This builder for chaining.

clearPageSize()

public ListDataPointsRequest.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. For exercise and sleep the default page size is 25. The maximum page size for exercise and sleep is 25.

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

Returns
Type	Description
ListDataPointsRequest.Builder	This builder for chaining.

clearPageToken()

public ListDataPointsRequest.Builder clearPageToken()

Optional. The next_page_token from a previous request, if any.

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

Returns
Type	Description
ListDataPointsRequest.Builder	This builder for chaining.

clearParent()

public ListDataPointsRequest.Builder clearParent()

Required. Parent data type of the Data Point collection.

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

• users/me/dataTypes/steps

• users/me/dataTypes/weight

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

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

Returns
Type	Description
ListDataPointsRequest.Builder	This builder for chaining.

getDefaultInstanceForType()

public ListDataPointsRequest getDefaultInstanceForType()

Returns
Type	Description
ListDataPointsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

Optional. Filter expression following https://google.aip.dev/160.

A time range (either physical or civil) can be specified.

The supported filter fields are:

• Interval start time:
• Pattern: {interval_data_type}.interval.start_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"

• distance.interval.start_time >= "2024-08-14T12:34:56Z"

• Interval civil start time:

• Pattern: {interval_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"

• distance.interval.civil_start_time >= "2024-08-14T12:34:56"

• Sample observation physical time:

• Pattern: {sample_data_type}.sample_time.physical_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"

• weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"

• Sample observation civil time:

• Pattern: {sample_data_type}.sample_time.civil_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"

• weight.sample_time.civil_time >= "2024-08-14T12:34:56"

• Daily summary date:

• Pattern: {daily_summary_data_type}.date
• Supported comparison operators: >=, <
• Date literal expected in ISO 8601 YYYY-MM-DD format
• Supported logical operators: AND
• Example:

• daily_heart_rate_variability.date < "2024-08-15"

• Session civil start time (Excluding Sleep and ECG):

• Pattern: {session_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"

• exercise.interval.civil_start_time >= "2024-08-14T12:34:56"

• Session start time (ECG specific):

• Pattern: electrocardiogram.interval.start_time
• Supported comparison operators: >=
• Timestamp literal expected in RFC-3339 format
• Example:
• electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"

• Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., electrocardiogram.interval.end_time) is not supported.

• Session end time (Sleep specific):

• Pattern: sleep.interval.end_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND, OR
• Example:

• sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"

• Session civil end time (Sleep specific):

• Pattern: sleep.interval.civil_end_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND, OR
• Example:
• sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"

Data points in the response will be ordered by the interval start time in descending order.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter expression following https://google.aip.dev/160.

A time range (either physical or civil) can be specified.

The supported filter fields are:

• Interval start time:
• Pattern: {interval_data_type}.interval.start_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"

• distance.interval.start_time >= "2024-08-14T12:34:56Z"

• Interval civil start time:

• Pattern: {interval_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"

• distance.interval.civil_start_time >= "2024-08-14T12:34:56"

• Sample observation physical time:

• Pattern: {sample_data_type}.sample_time.physical_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"

• weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"

• Sample observation civil time:

• Pattern: {sample_data_type}.sample_time.civil_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"

• weight.sample_time.civil_time >= "2024-08-14T12:34:56"

• Daily summary date:

• Pattern: {daily_summary_data_type}.date
• Supported comparison operators: >=, <
• Date literal expected in ISO 8601 YYYY-MM-DD format
• Supported logical operators: AND
• Example:

• daily_heart_rate_variability.date < "2024-08-15"

• Session civil start time (Excluding Sleep and ECG):

• Pattern: {session_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"

• exercise.interval.civil_start_time >= "2024-08-14T12:34:56"

• Session start time (ECG specific):

• Pattern: electrocardiogram.interval.start_time
• Supported comparison operators: >=
• Timestamp literal expected in RFC-3339 format
• Example:
• electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"

• Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., electrocardiogram.interval.end_time) is not supported.

• Session end time (Sleep specific):

• Pattern: sleep.interval.end_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND, OR
• Example:

• sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"

• Session civil end time (Sleep specific):

• Pattern: sleep.interval.civil_end_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND, OR
• Example:
• sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"

Data points in the response will be ordered by the interval start time in descending order.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for filter.

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. For exercise and sleep the default page size is 25. The maximum page size for exercise and sleep is 25.

int32 page_size = 2 [(.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.

string page_token = 3 [(.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.

string page_token = 3 [(.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/me/dataTypes/{data_type}, e.g.:

• users/me/dataTypes/steps

• users/me/dataTypes/weight

  For a list of the supported data types see the DataPoint data 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/me/dataTypes/{data_type}, e.g.:

• users/me/dataTypes/steps

• users/me/dataTypes/weight

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

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

Returns
Type	Description
ByteString	The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(ListDataPointsRequest other)

public ListDataPointsRequest.Builder mergeFrom(ListDataPointsRequest other)

Parameter
Name	Description
other	ListDataPointsRequest

Returns
Type	Description
ListDataPointsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDataPointsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListDataPointsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListDataPointsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListDataPointsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setFilter(String value)

public ListDataPointsRequest.Builder setFilter(String value)

Optional. Filter expression following https://google.aip.dev/160.

A time range (either physical or civil) can be specified.

The supported filter fields are:

• Interval start time:
• Pattern: {interval_data_type}.interval.start_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"

• distance.interval.start_time >= "2024-08-14T12:34:56Z"

• Interval civil start time:

• Pattern: {interval_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"

• distance.interval.civil_start_time >= "2024-08-14T12:34:56"

• Sample observation physical time:

• Pattern: {sample_data_type}.sample_time.physical_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"

• weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"

• Sample observation civil time:

• Pattern: {sample_data_type}.sample_time.civil_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"

• weight.sample_time.civil_time >= "2024-08-14T12:34:56"

• Daily summary date:

• Pattern: {daily_summary_data_type}.date
• Supported comparison operators: >=, <
• Date literal expected in ISO 8601 YYYY-MM-DD format
• Supported logical operators: AND
• Example:

• daily_heart_rate_variability.date < "2024-08-15"

• Session civil start time (Excluding Sleep and ECG):

• Pattern: {session_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"

• exercise.interval.civil_start_time >= "2024-08-14T12:34:56"

• Session start time (ECG specific):

• Pattern: electrocardiogram.interval.start_time
• Supported comparison operators: >=
• Timestamp literal expected in RFC-3339 format
• Example:
• electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"

• Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., electrocardiogram.interval.end_time) is not supported.

• Session end time (Sleep specific):

• Pattern: sleep.interval.end_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND, OR
• Example:

• sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"

• Session civil end time (Sleep specific):

• Pattern: sleep.interval.civil_end_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND, OR
• Example:
• sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"

Data points in the response will be ordered by the interval start time in descending order.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The filter to set.

Returns
Type	Description
ListDataPointsRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ListDataPointsRequest.Builder setFilterBytes(ByteString value)

Optional. Filter expression following https://google.aip.dev/160.

A time range (either physical or civil) can be specified.

The supported filter fields are:

• Interval start time:
• Pattern: {interval_data_type}.interval.start_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"

• distance.interval.start_time >= "2024-08-14T12:34:56Z"

• Interval civil start time:

• Pattern: {interval_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"

• distance.interval.civil_start_time >= "2024-08-14T12:34:56"

• Sample observation physical time:

• Pattern: {sample_data_type}.sample_time.physical_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND
• Example:
• weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"

• weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"

• Sample observation civil time:

• Pattern: {sample_data_type}.sample_time.civil_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"

• weight.sample_time.civil_time >= "2024-08-14T12:34:56"

• Daily summary date:

• Pattern: {daily_summary_data_type}.date
• Supported comparison operators: >=, <
• Date literal expected in ISO 8601 YYYY-MM-DD format
• Supported logical operators: AND
• Example:

• daily_heart_rate_variability.date < "2024-08-15"

• Session civil start time (Excluding Sleep and ECG):

• Pattern: {session_data_type}.interval.civil_start_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND
• Example:
• exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"

• exercise.interval.civil_start_time >= "2024-08-14T12:34:56"

• Session start time (ECG specific):

• Pattern: electrocardiogram.interval.start_time
• Supported comparison operators: >=
• Timestamp literal expected in RFC-3339 format
• Example:
• electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"

• Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., electrocardiogram.interval.end_time) is not supported.

• Session end time (Sleep specific):

• Pattern: sleep.interval.end_time
• Supported comparison operators: >=, <
• Timestamp literal expected in RFC-3339 format
• Supported logical operators: AND, OR
• Example:

• sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"

• Session civil end time (Sleep specific):

• Pattern: sleep.interval.civil_end_time
• Supported comparison operators: >=, <
• Date with optional time literal expected in ISO 8601 YYYY-MM-DD[THH:mm:ss] format
• Supported logical operators: AND, OR
• Example:
• sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"

Data points in the response will be ordered by the interval start time in descending order.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for filter to set.

Returns
Type	Description
ListDataPointsRequest.Builder	This builder for chaining.

setPageSize(int value)

public ListDataPointsRequest.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. For exercise and sleep the default page size is 25. The maximum page size for exercise and sleep is 25.

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

Parameter
Name	Description
value	int The pageSize to set.

Returns
Type	Description
ListDataPointsRequest.Builder	This builder for chaining.

setPageToken(String value)

public ListDataPointsRequest.Builder setPageToken(String value)

Optional. The next_page_token from a previous request, if any.

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

Parameter
Name	Description
value	String The pageToken to set.

Returns
Type	Description
ListDataPointsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListDataPointsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The next_page_token from a previous request, if any.

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

Parameter
Name	Description
value	ByteString The bytes for pageToken to set.

Returns
Type	Description
ListDataPointsRequest.Builder	This builder for chaining.

setParent(String value)

public ListDataPointsRequest.Builder setParent(String value)

Required. Parent data type of the Data Point collection.

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

• users/me/dataTypes/steps

• users/me/dataTypes/weight

  For a list of the supported data types see the DataPoint data 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
ListDataPointsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public ListDataPointsRequest.Builder setParentBytes(ByteString value)

Required. Parent data type of the Data Point collection.

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

• users/me/dataTypes/steps

• users/me/dataTypes/weight

  For a list of the supported data types see the DataPoint data 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
ListDataPointsRequest.Builder	This builder for chaining.