Class RollUpDataPointsRequest (0.2.0)

public final class RollUpDataPointsRequest extends GeneratedMessage implements RollUpDataPointsRequestOrBuilder

Request to roll up data points by physical time intervals.

Protobuf type google.devicesandservices.health.v4.RollUpDataPointsRequest

Static Fields

DATA_SOURCE_FAMILY_FIELD_NUMBER

public static final int DATA_SOURCE_FAMILY_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

RANGE_FIELD_NUMBER

public static final int RANGE_FIELD_NUMBER
Field Value
Type Description
int

WINDOW_SIZE_FIELD_NUMBER

public static final int WINDOW_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RollUpDataPointsRequest getDefaultInstance()
Returns
Type Description
RollUpDataPointsRequest

getDescriptor()

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

newBuilder()

public static RollUpDataPointsRequest.Builder newBuilder()
Returns
Type Description
RollUpDataPointsRequest.Builder

newBuilder(RollUpDataPointsRequest prototype)

public static RollUpDataPointsRequest.Builder newBuilder(RollUpDataPointsRequest prototype)
Parameter
Name Description
prototype RollUpDataPointsRequest
Returns
Type Description
RollUpDataPointsRequest.Builder

parseDelimitedFrom(InputStream input)

public static RollUpDataPointsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RollUpDataPointsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RollUpDataPointsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RollUpDataPointsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RollUpDataPointsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RollUpDataPointsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RollUpDataPointsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RollUpDataPointsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RollUpDataPointsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RollUpDataPointsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RollUpDataPointsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RollUpDataPointsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RollUpDataPointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RollUpDataPointsRequest> parser()
Returns
Type Description
Parser<RollUpDataPointsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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
  • users/me/dataSourceFamilies/google-wearables - tracker devices
  • users/me/dataSourceFamilies/google-sources - Google first party sources

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
  • users/me/dataSourceFamilies/google-wearables - tracker devices
  • users/me/dataSourceFamilies/google-sources - Google first party sources

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

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.

getParserForType()

public Parser<RollUpDataPointsRequest> getParserForType()
Returns
Type Description
Parser<RollUpDataPointsRequest>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWindowSize()

public Duration getWindowSize()

Required. The size of the time window to group data points into before applying the aggregation functions.

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

Returns
Type Description
Duration

The windowSize.

getWindowSizeOrBuilder()

public DurationOrBuilder getWindowSizeOrBuilder()

Required. The size of the time window to group data points into before applying the aggregation functions.

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

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

Returns
Type Description
boolean

Whether the windowSize field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RollUpDataPointsRequest.Builder newBuilderForType()
Returns
Type Description
RollUpDataPointsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RollUpDataPointsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RollUpDataPointsRequest.Builder
Overrides

toBuilder()

public RollUpDataPointsRequest.Builder toBuilder()
Returns
Type Description
RollUpDataPointsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException