Class: Google::Apis::HealthV4::Exercise

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/health_v4/classes.rb,
lib/google/apis/health_v4/representations.rb,
lib/google/apis/health_v4/representations.rb

Overview

An exercise that stores information about a physical activity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Exercise

Returns a new instance of Exercise.



2272
2273
2274
 
# File 'lib/google/apis/health_v4/classes.rb', line 2272

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#active_duration ⇒ String

Optional. Duration excluding pauses. Corresponds to the JSON property activeDuration

Returns:

  • (String) 


2205
2206
2207
 
# File 'lib/google/apis/health_v4/classes.rb', line 2205

def active_duration
  @active_duration
end

#create_time ⇒ String

Output only. Represents the timestamp of the creation of the exercise. Corresponds to the JSON property createTime

Returns:

  • (String) 


2210
2211
2212
 
# File 'lib/google/apis/health_v4/classes.rb', line 2210

def create_time
  @create_time
end

#display_name ⇒ String

Required. The localized, human-readable name of the exercise. For all exercise types other than OTHER, the system ignores client input and overrides this field with a generated name based on exercise_type (e.g., "Walking" for WALKING). If exercise_type is OTHER, this field can contain the user's custom, free-form display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


2219
2220
2221
 
# File 'lib/google/apis/health_v4/classes.rb', line 2219

def display_name
  @display_name
end

#exercise_events ⇒ Array<Google::Apis::HealthV4::ExerciseEvent>

Optional. Exercise events that happen during an exercise, such as pause & restarts. Corresponds to the JSON property exerciseEvents

Returns:



2225
2226
2227
 
# File 'lib/google/apis/health_v4/classes.rb', line 2225

def exercise_events
  @exercise_events
end

#exercise_metadata ⇒ Google::Apis::HealthV4::ExerciseMetadata

Additional exercise metadata. Corresponds to the JSON property exerciseMetadata

Returns:



2230
2231
2232
 
# File 'lib/google/apis/health_v4/classes.rb', line 2230

def exercise_metadata
  @exercise_metadata
end

#exercise_type ⇒ String

Required. The type of activity performed during an exercise. Corresponds to the JSON property exerciseType

Returns:

  • (String) 


2235
2236
2237
 
# File 'lib/google/apis/health_v4/classes.rb', line 2235

def exercise_type
  @exercise_type
end

#interval ⇒ Google::Apis::HealthV4::SessionTimeInterval

Represents a time interval of session data point, which bundles multiple observed metrics together. Corresponds to the JSON property interval

Returns:



2241
2242
2243
 
# File 'lib/google/apis/health_v4/classes.rb', line 2241

def interval
  @interval
end

#metrics_summary ⇒ Google::Apis::HealthV4::MetricsSummary

Summary metrics for an exercise. Corresponds to the JSON property metricsSummary

Returns:



2246
2247
2248
 
# File 'lib/google/apis/health_v4/classes.rb', line 2246

def metrics_summary
  @metrics_summary
end

#notes ⇒ String

Optional. Standard free-form notes captured at manual logging. Corresponds to the JSON property notes

Returns:

  • (String) 


2251
2252
2253
 
# File 'lib/google/apis/health_v4/classes.rb', line 2251

def notes
  @notes
end

#split_summaries ⇒ Array<Google::Apis::HealthV4::SplitSummary>

Optional. Laps or splits recorded within an exercise. Laps could be split based on distance or other criteria (duration, etc.) Laps should not be overlapping with each other. Corresponds to the JSON property splitSummaries

Returns:



2258
2259
2260
 
# File 'lib/google/apis/health_v4/classes.rb', line 2258

def split_summaries
  @split_summaries
end

#splits ⇒ Array<Google::Apis::HealthV4::SplitSummary>

Optional. The default split is 1 km or 1 mile. - if the movement distance is less than the default, then there are no splits - if the movement distance is greater than or equal to the default, then we have splits Corresponds to the JSON property splits

Returns:



2265
2266
2267
 
# File 'lib/google/apis/health_v4/classes.rb', line 2265

def splits
  @splits
end

#update_time ⇒ String

Output only. This is the timestamp of the last update to the exercise. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2270
2271
2272
 
# File 'lib/google/apis/health_v4/classes.rb', line 2270

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
 
# File 'lib/google/apis/health_v4/classes.rb', line 2277

def update!(**args)
  @active_duration = args[:active_duration] if args.key?(:active_duration)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @exercise_events = args[:exercise_events] if args.key?(:exercise_events)
  @exercise_metadata = args[:exercise_metadata] if args.key?(:exercise_metadata)
  @exercise_type = args[:exercise_type] if args.key?(:exercise_type)
  @interval = args[:interval] if args.key?(:interval)
  @metrics_summary = args[:metrics_summary] if args.key?(:metrics_summary)
  @notes = args[:notes] if args.key?(:notes)
  @split_summaries = args[:split_summaries] if args.key?(:split_summaries)
  @splits = args[:splits] if args.key?(:splits)
  @update_time = args[:update_time] if args.key?(:update_time)
end