Class: Google::Apis::FitnessV1::DataTypeField

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DataTypeField

Returns a new instance of DataTypeField



595
596
597
 
# File 'generated/google/apis/fitness_v1/classes.rb', line 595

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

Returns:

  • (String) 


581
582
583
 
# File 'generated/google/apis/fitness_v1/classes.rb', line 581

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

Returns:

  • (String) 


587
588
589
 
# File 'generated/google/apis/fitness_v1/classes.rb', line 587

def name
  @name
end

#optional ⇒ Boolean Also known as: optional?

Corresponds to the JSON property optional

Returns:

  • (Boolean) 


592
593
594
 
# File 'generated/google/apis/fitness_v1/classes.rb', line 592

def optional
  @optional
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



600
601
602
603
604
 
# File 'generated/google/apis/fitness_v1/classes.rb', line 600

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