Class MetricsSummary.Builder (0.2.0)

public static final class MetricsSummary.Builder extends GeneratedMessage.Builder<MetricsSummary.Builder> implements MetricsSummaryOrBuilder

Summary metrics for an exercise.

Protobuf type google.devicesandservices.health.v4.MetricsSummary

Static Methods

getDescriptor()

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

Methods

build()

public MetricsSummary build()
Returns
Type Description
MetricsSummary

buildPartial()

public MetricsSummary buildPartial()
Returns
Type Description
MetricsSummary

clear()

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

clearActiveZoneMinutes()

public MetricsSummary.Builder clearActiveZoneMinutes()

Optional. Total active zone minutes for the exercise.

optional int64 active_zone_minutes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

clearAverageHeartRateBeatsPerMinute()

public MetricsSummary.Builder clearAverageHeartRateBeatsPerMinute()

Optional. Average heart rate during the exercise.

optional int64 average_heart_rate_beats_per_minute = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

clearAveragePaceSecondsPerMeter()

public MetricsSummary.Builder clearAveragePaceSecondsPerMeter()

Optional. Average pace in seconds per meter.

optional double average_pace_seconds_per_meter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

clearAverageSpeedMillimetersPerSecond()

public MetricsSummary.Builder clearAverageSpeedMillimetersPerSecond()

Optional. Average speed in millimeters per second.

optional double average_speed_millimeters_per_second = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

clearCaloriesKcal()

public MetricsSummary.Builder clearCaloriesKcal()

Optional. Total calories burned by the user during the exercise.

optional double calories_kcal = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

clearDistanceMillimeters()

public MetricsSummary.Builder clearDistanceMillimeters()

Optional. Total distance covered by the user during the exercise.

optional double distance_millimeters = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

clearElevationGainMillimeters()

public MetricsSummary.Builder clearElevationGainMillimeters()

Optional. Total elevation gain during the exercise.

optional double elevation_gain_millimeters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

clearHeartRateZoneDurations()

public MetricsSummary.Builder clearHeartRateZoneDurations()

Optional. Time spent in each heart rate zone.

.google.devicesandservices.health.v4.MetricsSummary.TimeInHeartRateZones heart_rate_zone_durations = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

clearMobilityMetrics()

public MetricsSummary.Builder clearMobilityMetrics()

Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.

.google.devicesandservices.health.v4.MetricsSummary.MobilityMetrics mobility_metrics = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

clearRunVo2Max()

public MetricsSummary.Builder clearRunVo2Max()

Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.

optional double run_vo2_max = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

clearSteps()

public MetricsSummary.Builder clearSteps()

Optional. Total steps taken during the exercise.

optional int64 steps = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

clearTotalSwimLengths()

public MetricsSummary.Builder clearTotalSwimLengths()

Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.

optional double total_swim_lengths = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

getActiveZoneMinutes()

public long getActiveZoneMinutes()

Optional. Total active zone minutes for the exercise.

optional int64 active_zone_minutes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The activeZoneMinutes.

getAverageHeartRateBeatsPerMinute()

public long getAverageHeartRateBeatsPerMinute()

Optional. Average heart rate during the exercise.

optional int64 average_heart_rate_beats_per_minute = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The averageHeartRateBeatsPerMinute.

getAveragePaceSecondsPerMeter()

public double getAveragePaceSecondsPerMeter()

Optional. Average pace in seconds per meter.

optional double average_pace_seconds_per_meter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The averagePaceSecondsPerMeter.

getAverageSpeedMillimetersPerSecond()

public double getAverageSpeedMillimetersPerSecond()

Optional. Average speed in millimeters per second.

optional double average_speed_millimeters_per_second = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The averageSpeedMillimetersPerSecond.

getCaloriesKcal()

public double getCaloriesKcal()

Optional. Total calories burned by the user during the exercise.

optional double calories_kcal = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The caloriesKcal.

getDefaultInstanceForType()

public MetricsSummary getDefaultInstanceForType()
Returns
Type Description
MetricsSummary

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDistanceMillimeters()

public double getDistanceMillimeters()

Optional. Total distance covered by the user during the exercise.

optional double distance_millimeters = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The distanceMillimeters.

getElevationGainMillimeters()

public double getElevationGainMillimeters()

Optional. Total elevation gain during the exercise.

optional double elevation_gain_millimeters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The elevationGainMillimeters.

getHeartRateZoneDurations()

public MetricsSummary.TimeInHeartRateZones getHeartRateZoneDurations()

Optional. Time spent in each heart rate zone.

.google.devicesandservices.health.v4.MetricsSummary.TimeInHeartRateZones heart_rate_zone_durations = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.TimeInHeartRateZones

The heartRateZoneDurations.

getHeartRateZoneDurationsBuilder()

public MetricsSummary.TimeInHeartRateZones.Builder getHeartRateZoneDurationsBuilder()

Optional. Time spent in each heart rate zone.

.google.devicesandservices.health.v4.MetricsSummary.TimeInHeartRateZones heart_rate_zone_durations = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.TimeInHeartRateZones.Builder

getHeartRateZoneDurationsOrBuilder()

public MetricsSummary.TimeInHeartRateZonesOrBuilder getHeartRateZoneDurationsOrBuilder()

Optional. Time spent in each heart rate zone.

.google.devicesandservices.health.v4.MetricsSummary.TimeInHeartRateZones heart_rate_zone_durations = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.TimeInHeartRateZonesOrBuilder

getMobilityMetrics()

public MetricsSummary.MobilityMetrics getMobilityMetrics()

Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.

.google.devicesandservices.health.v4.MetricsSummary.MobilityMetrics mobility_metrics = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.MobilityMetrics

The mobilityMetrics.

getMobilityMetricsBuilder()

public MetricsSummary.MobilityMetrics.Builder getMobilityMetricsBuilder()

Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.

.google.devicesandservices.health.v4.MetricsSummary.MobilityMetrics mobility_metrics = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.MobilityMetrics.Builder

getMobilityMetricsOrBuilder()

public MetricsSummary.MobilityMetricsOrBuilder getMobilityMetricsOrBuilder()

Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.

.google.devicesandservices.health.v4.MetricsSummary.MobilityMetrics mobility_metrics = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricsSummary.MobilityMetricsOrBuilder

getRunVo2Max()

public double getRunVo2Max()

Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.

optional double run_vo2_max = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The runVo2Max.

getSteps()

public long getSteps()

Optional. Total steps taken during the exercise.

optional int64 steps = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The steps.

getTotalSwimLengths()

public double getTotalSwimLengths()

Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.

optional double total_swim_lengths = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The totalSwimLengths.

hasActiveZoneMinutes()

public boolean hasActiveZoneMinutes()

Optional. Total active zone minutes for the exercise.

optional int64 active_zone_minutes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the activeZoneMinutes field is set.

hasAverageHeartRateBeatsPerMinute()

public boolean hasAverageHeartRateBeatsPerMinute()

Optional. Average heart rate during the exercise.

optional int64 average_heart_rate_beats_per_minute = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the averageHeartRateBeatsPerMinute field is set.

hasAveragePaceSecondsPerMeter()

public boolean hasAveragePaceSecondsPerMeter()

Optional. Average pace in seconds per meter.

optional double average_pace_seconds_per_meter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the averagePaceSecondsPerMeter field is set.

hasAverageSpeedMillimetersPerSecond()

public boolean hasAverageSpeedMillimetersPerSecond()

Optional. Average speed in millimeters per second.

optional double average_speed_millimeters_per_second = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the averageSpeedMillimetersPerSecond field is set.

hasCaloriesKcal()

public boolean hasCaloriesKcal()

Optional. Total calories burned by the user during the exercise.

optional double calories_kcal = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the caloriesKcal field is set.

hasDistanceMillimeters()

public boolean hasDistanceMillimeters()

Optional. Total distance covered by the user during the exercise.

optional double distance_millimeters = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the distanceMillimeters field is set.

hasElevationGainMillimeters()

public boolean hasElevationGainMillimeters()

Optional. Total elevation gain during the exercise.

optional double elevation_gain_millimeters = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the elevationGainMillimeters field is set.

hasHeartRateZoneDurations()

public boolean hasHeartRateZoneDurations()

Optional. Time spent in each heart rate zone.

.google.devicesandservices.health.v4.MetricsSummary.TimeInHeartRateZones heart_rate_zone_durations = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the heartRateZoneDurations field is set.

hasMobilityMetrics()

public boolean hasMobilityMetrics()

Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.

.google.devicesandservices.health.v4.MetricsSummary.MobilityMetrics mobility_metrics = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the mobilityMetrics field is set.

hasRunVo2Max()

public boolean hasRunVo2Max()

Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.

optional double run_vo2_max = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the runVo2Max field is set.

hasSteps()

public boolean hasSteps()

Optional. Total steps taken during the exercise.

optional int64 steps = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the steps field is set.

hasTotalSwimLengths()

public boolean hasTotalSwimLengths()

Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.

optional double total_swim_lengths = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the totalSwimLengths field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MetricsSummary other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeHeartRateZoneDurations(MetricsSummary.TimeInHeartRateZones value)

public MetricsSummary.Builder mergeHeartRateZoneDurations(MetricsSummary.TimeInHeartRateZones value)

Optional. Time spent in each heart rate zone.

.google.devicesandservices.health.v4.MetricsSummary.TimeInHeartRateZones heart_rate_zone_durations = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetricsSummary.TimeInHeartRateZones
Returns
Type Description
MetricsSummary.Builder

mergeMobilityMetrics(MetricsSummary.MobilityMetrics value)

public MetricsSummary.Builder mergeMobilityMetrics(MetricsSummary.MobilityMetrics value)

Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.

.google.devicesandservices.health.v4.MetricsSummary.MobilityMetrics mobility_metrics = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetricsSummary.MobilityMetrics
Returns
Type Description
MetricsSummary.Builder

setActiveZoneMinutes(long value)

public MetricsSummary.Builder setActiveZoneMinutes(long value)

Optional. Total active zone minutes for the exercise.

optional int64 active_zone_minutes = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The activeZoneMinutes to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

setAverageHeartRateBeatsPerMinute(long value)

public MetricsSummary.Builder setAverageHeartRateBeatsPerMinute(long value)

Optional. Average heart rate during the exercise.

optional int64 average_heart_rate_beats_per_minute = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The averageHeartRateBeatsPerMinute to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

setAveragePaceSecondsPerMeter(double value)

public MetricsSummary.Builder setAveragePaceSecondsPerMeter(double value)

Optional. Average pace in seconds per meter.

optional double average_pace_seconds_per_meter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The averagePaceSecondsPerMeter to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

setAverageSpeedMillimetersPerSecond(double value)

public MetricsSummary.Builder setAverageSpeedMillimetersPerSecond(double value)

Optional. Average speed in millimeters per second.

optional double average_speed_millimeters_per_second = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The averageSpeedMillimetersPerSecond to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

setCaloriesKcal(double value)

public MetricsSummary.Builder setCaloriesKcal(double value)

Optional. Total calories burned by the user during the exercise.

optional double calories_kcal = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The caloriesKcal to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

setDistanceMillimeters(double value)

public MetricsSummary.Builder setDistanceMillimeters(double value)

Optional. Total distance covered by the user during the exercise.

optional double distance_millimeters = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The distanceMillimeters to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

setElevationGainMillimeters(double value)

public MetricsSummary.Builder setElevationGainMillimeters(double value)

Optional. Total elevation gain during the exercise.

optional double elevation_gain_millimeters = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The elevationGainMillimeters to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

setHeartRateZoneDurations(MetricsSummary.TimeInHeartRateZones value)

public MetricsSummary.Builder setHeartRateZoneDurations(MetricsSummary.TimeInHeartRateZones value)

Optional. Time spent in each heart rate zone.

.google.devicesandservices.health.v4.MetricsSummary.TimeInHeartRateZones heart_rate_zone_durations = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetricsSummary.TimeInHeartRateZones
Returns
Type Description
MetricsSummary.Builder

setHeartRateZoneDurations(MetricsSummary.TimeInHeartRateZones.Builder builderForValue)

public MetricsSummary.Builder setHeartRateZoneDurations(MetricsSummary.TimeInHeartRateZones.Builder builderForValue)

Optional. Time spent in each heart rate zone.

.google.devicesandservices.health.v4.MetricsSummary.TimeInHeartRateZones heart_rate_zone_durations = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue MetricsSummary.TimeInHeartRateZones.Builder
Returns
Type Description
MetricsSummary.Builder

setMobilityMetrics(MetricsSummary.MobilityMetrics value)

public MetricsSummary.Builder setMobilityMetrics(MetricsSummary.MobilityMetrics value)

Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.

.google.devicesandservices.health.v4.MetricsSummary.MobilityMetrics mobility_metrics = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetricsSummary.MobilityMetrics
Returns
Type Description
MetricsSummary.Builder

setMobilityMetrics(MetricsSummary.MobilityMetrics.Builder builderForValue)

public MetricsSummary.Builder setMobilityMetrics(MetricsSummary.MobilityMetrics.Builder builderForValue)

Optional. Mobility workouts specific metrics. Only present in the advanced running exercises.

.google.devicesandservices.health.v4.MetricsSummary.MobilityMetrics mobility_metrics = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue MetricsSummary.MobilityMetrics.Builder
Returns
Type Description
MetricsSummary.Builder

setRunVo2Max(double value)

public MetricsSummary.Builder setRunVo2Max(double value)

Optional. Run VO2 max value for the exercise. Only present in the running exercises at the top level as in the summary of the whole exercise.

optional double run_vo2_max = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The runVo2Max to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

setSteps(long value)

public MetricsSummary.Builder setSteps(long value)

Optional. Total steps taken during the exercise.

optional int64 steps = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The steps to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.

setTotalSwimLengths(double value)

public MetricsSummary.Builder setTotalSwimLengths(double value)

Optional. Number of full pool lengths completed during the exercise. Only present in the swimming exercises at the top level as in the summary of the whole exercise.

optional double total_swim_lengths = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The totalSwimLengths to set.

Returns
Type Description
MetricsSummary.Builder

This builder for chaining.