com.google.api.services.fitness

Class Fitness.Users.DataSources

java.lang.Object

com.google.api.services.fitness.Fitness.Users.DataSources

Enclosing class:

Fitness.Users

public class Fitness.Users.DataSources
extends Object

The "dataSources" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Fitness.Users.DataSources.Create
class	Fitness.Users.DataSources.DataPointChanges The "dataPointChanges" collection of methods.
class	Fitness.Users.DataSources.Datasets The "datasets" collection of methods.
class	Fitness.Users.DataSources.Delete
class	Fitness.Users.DataSources.Get
class	Fitness.Users.DataSources.List
class	Fitness.Users.DataSources.Update

Constructor Summary

Constructors

Constructor and Description
DataSources()

Method Summary

Modifier and Type	Method and Description
Fitness.Users.DataSources.Create	create(String userId, DataSource content) Creates a new data source that is unique across all data sources belonging to this user.
Fitness.Users.DataSources.DataPointChanges	dataPointChanges() An accessor for creating requests from the DataPointChanges collection.
Fitness.Users.DataSources.Datasets	datasets() An accessor for creating requests from the Datasets collection.
Fitness.Users.DataSources.Delete	delete(String userId, String dataSourceId) Deletes the specified data source.
Fitness.Users.DataSources.Get	get(String userId, String dataSourceId) Returns the specified data source.
Fitness.Users.DataSources.List	list(String userId) Lists all data sources that are visible to the developer, using the OAuth scopes provided.
Fitness.Users.DataSources.Update	update(String userId, String dataSourceId, DataSource content) Updates the specified data source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataSources

public DataSources()

Method Detail

create

public Fitness.Users.DataSources.Create create(String userId,
                                               DataSource content)
                                        throws IOException

Creates a new data source that is unique across all data sources belonging to this user. A data source is 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 in every dataset inserted into or read from the Fitness API has an associated data source. Each data source produces a unique stream of dataset updates, with a unique data source identifier. Not all changes to data source affect the data stream ID, so that data collected by updated versions of the same application/device can still be considered to belong to the same data source. Data sources are identified using a string generated by the server, based on the contents of the source being created. The dataStreamId field should not be set when invoking this method. It will be automatically generated by the server with the correct format. If a dataStreamId is set, it must match the format that the server would generate. This format is a combination of some fields from the data source, and has a specific order. If it doesn't match, the request will fail with an error. Specifying a DataType which is not a known type (beginning with "com.google.") will create a DataSource with a *custom data type*. Custom data types are only readable by the application that created them. Custom data types are *deprecated*; use standard data types instead. In addition to the data source fields included in the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types. Create a request for the method "dataSources.create". This request holds the parameters needed by the fitness server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - Create the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

content - the DataSource

Returns:

the request

Throws:

IOException

delete

public Fitness.Users.DataSources.Delete delete(String userId,
                                               String dataSourceId)
                                        throws IOException

Deletes the specified data source. The request will fail if the data source contains any data points. Create a request for the method "dataSources.delete". This request holds the parameters needed by the fitness server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

dataSourceId - The data stream ID of the data source to delete.

Returns:

the request

Throws:

IOException

get

public Fitness.Users.DataSources.Get get(String userId,
                                         String dataSourceId)
                                  throws IOException

Returns the specified data source. Create a request for the method "dataSources.get". This request holds the parameters needed by the fitness server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - Retrieve a data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

dataSourceId - The data stream ID of the data source to retrieve.

Returns:

the request

Throws:

IOException

list

public Fitness.Users.DataSources.List list(String userId)
                                    throws IOException

Lists all data sources that are visible to the developer, using the OAuth scopes provided. The list is not exhaustive; the user may have private data sources that are only visible to other developers, or calls using other scopes. Create a request for the method "dataSources.list". This request holds the parameters needed by the fitness server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - List data sources for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

Returns:

the request

Throws:

IOException

update

public Fitness.Users.DataSources.Update update(String userId,
                                               String dataSourceId,
                                               DataSource content)
                                        throws IOException

Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified. Data sources are identified by their dataStreamId. Create a request for the method "dataSources.update". This request holds the parameters needed by the fitness server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - Update the data source for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

dataSourceId - The data stream ID of the data source to update.

content - the DataSource

Returns:

the request

Throws:

IOException

dataPointChanges

public Fitness.Users.DataSources.DataPointChanges dataPointChanges()

An accessor for creating requests from the DataPointChanges collection.

The typical use is:

    Fitness fitness = new Fitness(...);
    Fitness.DataPointChanges.List request = fitness.dataPointChanges().list(parameters ...)
 

Returns:

the resource collection

datasets

public Fitness.Users.DataSources.Datasets datasets()

An accessor for creating requests from the Datasets collection.

The typical use is:

    Fitness fitness = new Fitness(...);
    Fitness.Datasets.List request = fitness.datasets().list(parameters ...)
 

Returns:

the resource collection