Interface ListDataPointsRequestOrBuilder (0.2.0) 

public interface ListDataPointsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

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