Class: Google::Apis::FitnessV1::DataTypeField
- Inherits:
-
Object
- Object
- Google::Apis::FitnessV1::DataTypeField
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/fitness_v1/classes.rb,
generated/google/apis/fitness_v1/representations.rb,
generated/google/apis/fitness_v1/representations.rb
Overview
In case of multi-dimensional data (such as an accelerometer with x, y, and z axes) each field represents one dimension. Each data type field has a unique name which identifies it. The field also defines the format of the data (int, float, etc.). This message is only instantiated in code and not used for wire comms or stored in any way.
Instance Attribute Summary collapse
-
#format ⇒ String
The different supported formats for each field in a data type.
-
#name ⇒ String
Defines the name and format of data.
-
#optional ⇒ Boolean
(also: #optional?)
Corresponds to the JSON property
optional
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DataTypeField
constructor
A new instance of DataTypeField.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ DataTypeField
Returns a new instance of DataTypeField.
605 606 607 |
# File 'generated/google/apis/fitness_v1/classes.rb', line 605 def initialize(**args) update!(**args) end |
Instance Attribute Details
#format ⇒ String
The different supported formats for each field in a data type.
Corresponds to the JSON property format
591 592 593 |
# File 'generated/google/apis/fitness_v1/classes.rb', line 591 def format @format end |
#name ⇒ String
Defines the name and format of data. Unlike data type names, field names are
not namespaced, and only need to be unique within the data type.
Corresponds to the JSON property name
597 598 599 |
# File 'generated/google/apis/fitness_v1/classes.rb', line 597 def name @name end |
#optional ⇒ Boolean Also known as: optional?
Corresponds to the JSON property optional
602 603 604 |
# File 'generated/google/apis/fitness_v1/classes.rb', line 602 def optional @optional end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
610 611 612 613 614 |
# File 'generated/google/apis/fitness_v1/classes.rb', line 610 def update!(**args) @format = args[:format] if args.key?(:format) @name = args[:name] if args.key?(:name) @optional = args[:optional] if args.key?(:optional) end |