Class ListDataPointsRequest (0.2.0)

public final class ListDataPointsRequest extends GeneratedMessage implements ListDataPointsRequestOrBuilder

Request for listing raw data points

Protobuf type google.devicesandservices.health.v4.ListDataPointsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ListDataPointsRequest

Implements

ListDataPointsRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

Field Value
Type	Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ListDataPointsRequest getDefaultInstance()

Returns
Type	Description
ListDataPointsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ListDataPointsRequest.Builder newBuilder()

Returns
Type	Description
ListDataPointsRequest.Builder

newBuilder(ListDataPointsRequest prototype)

public static ListDataPointsRequest.Builder newBuilder(ListDataPointsRequest prototype)

Parameter
Name	Description
prototype	ListDataPointsRequest

Returns
Type	Description
ListDataPointsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListDataPointsRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDataPointsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ListDataPointsRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListDataPointsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListDataPointsRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListDataPointsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListDataPointsRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDataPointsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ListDataPointsRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDataPointsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ListDataPointsRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListDataPointsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListDataPointsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ListDataPointsRequest> parser()

Returns
Type	Description
Parser<ListDataPointsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public ListDataPointsRequest getDefaultInstanceForType()

Returns
Type	Description
ListDataPointsRequest

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.

getParserForType()

public Parser<ListDataPointsRequest> getParserForType()

Returns
Type	Description
Parser<ListDataPointsRequest>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public ListDataPointsRequest.Builder newBuilderForType()

Returns
Type	Description
ListDataPointsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ListDataPointsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ListDataPointsRequest.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ListDataPointsRequest.Builder toBuilder()

Returns
Type	Description
ListDataPointsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException