com.google.api.services.fitness.model

Class DataSource

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.fitness.model.DataSource

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DataSource
extends GenericJson

Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source. The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type. Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Fitness API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DataSource()

Method Summary

Modifier and Type	Method and Description
DataSource	clone()
Application	getApplication() Information about an application which feeds sensor data into the platform.
List<String>	getDataQualityStandard() DO NOT POPULATE THIS FIELD.
String	getDataStreamId() A unique identifier for the data stream produced by this data source.
String	getDataStreamName() The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer.
DataType	getDataType() The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
Device	getDevice() Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
String	getName() An end-user visible name for this data source.
String	getType() A constant describing the type of this data source.
DataSource	set(String fieldName, Object value)
DataSource	setApplication(Application application) Information about an application which feeds sensor data into the platform.
DataSource	setDataQualityStandard(List<String> dataQualityStandard) DO NOT POPULATE THIS FIELD.
DataSource	setDataStreamId(String dataStreamId) A unique identifier for the data stream produced by this data source.
DataSource	setDataStreamName(String dataStreamName) The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer.
DataSource	setDataType(DataType dataType) The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
DataSource	setDevice(Device device) Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
DataSource	setName(String name) An end-user visible name for this data source.
DataSource	setType(String type) A constant describing the type of this data source.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DataSource

public DataSource()

Method Detail

getApplication

public Application getApplication()

Information about an application which feeds sensor data into the platform.

Returns:

value or null for none

setApplication

public DataSource setApplication(Application application)

Information about an application which feeds sensor data into the platform.

Parameters:

application - application or null for none

getDataQualityStandard

public List<String> getDataQualityStandard()

DO NOT POPULATE THIS FIELD. It is never populated in responses from the platform, and is ignored in queries. It will be removed in a future version entirely.

Returns:

value or null for none

setDataQualityStandard

public DataSource setDataQualityStandard(List<String> dataQualityStandard)

DO NOT POPULATE THIS FIELD. It is never populated in responses from the platform, and is ignored in queries. It will be removed in a future version entirely.

Parameters:

dataQualityStandard - dataQualityStandard or null for none

getDataStreamId

public String getDataStreamId()

A unique identifier for the data stream produced by this data source. The identifier includes: - The physical device's manufacturer, model, and serial number (UID). - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. - The data source's type. - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal. The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStre amName The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName When any of the optional fields that make up the data stream ID are absent, they will be omitted from the data stream ID. The minimum viable data stream ID would be: type:dataType.name:developer project number Finally, the developer project number and device UID are obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form. This means a client will see a different set of data_stream_ids than another client with different credentials.

Returns:

value or null for none

setDataStreamId

public DataSource setDataStreamId(String dataStreamId)

A unique identifier for the data stream produced by this data source. The identifier includes: - The physical device's manufacturer, model, and serial number (UID). - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. - The data source's type. - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal. The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStre amName The exact format of the data stream ID created by a REST client is: type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName When any of the optional fields that make up the data stream ID are absent, they will be omitted from the data stream ID. The minimum viable data stream ID would be: type:dataType.name:developer project number Finally, the developer project number and device UID are obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form. This means a client will see a different set of data_stream_ids than another client with different credentials.

Parameters:

dataStreamId - dataStreamId or null for none

getDataStreamName

public String getDataStreamName()

The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.

Returns:

value or null for none

setDataStreamName

public DataSource setDataStreamName(String dataStreamName)

The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.

Parameters:

dataStreamName - dataStreamName or null for none

getDataType

public DataType getDataType()

The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.

Returns:

value or null for none

setDataType

public DataSource setDataType(DataType dataType)

The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.

Parameters:

dataType - dataType or null for none

getDevice

public Device getDevice()

Representation of an integrated device (such as a phone or a wearable) that can hold sensors.

Returns:

value or null for none

setDevice

public DataSource setDevice(Device device)

Representation of an integrated device (such as a phone or a wearable) that can hold sensors.

Parameters:

device - device or null for none

getName

public String getName()

An end-user visible name for this data source.

Returns:

value or null for none

setName

public DataSource setName(String name)

An end-user visible name for this data source.

Parameters:

name - name or null for none

getType

public String getType()

A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.

Returns:

value or null for none

setType

public DataSource setType(String type)

A constant describing the type of this data source. Indicates whether this data source produces raw or derived data.

Parameters:

type - type or null for none

set

public DataSource set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public DataSource clone()

Overrides:

clone in class GenericJson