com.google.api.services.fitness

Class Fitness.Users.DataSources.Datasets.Get

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.fitness.FitnessRequest<Dataset>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Fitness.Users.DataSources.Datasets

public class Fitness.Users.DataSources.Datasets.Get
extends FitnessRequest<Dataset>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Get(String userId, String dataSourceId, String datasetId) Returns a dataset containing all data points whose start and end times overlap with the specified range of the dataset minimum start time and maximum end time.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getDatasetId() Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch.
String	getDataSourceId() The data stream ID of the data source that created the dataset.
Integer	getLimit() If specified, no more than this many data points will be included in the dataset.
String	getPageToken() The continuation token, which is used to page through large datasets.
String	getUserId() Retrieve a dataset for the person identified.
Fitness.Users.DataSources.Datasets.Get	set(String parameterName, Object value)
Fitness.Users.DataSources.Datasets.Get	set$Xgafv(String $Xgafv) V1 error format.
Fitness.Users.DataSources.Datasets.Get	setAccessToken(String accessToken) OAuth access token.
Fitness.Users.DataSources.Datasets.Get	setAlt(String alt) Data format for response.
Fitness.Users.DataSources.Datasets.Get	setCallback(String callback) JSONP
Fitness.Users.DataSources.Datasets.Get	setDatasetId(String datasetId) Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch.
Fitness.Users.DataSources.Datasets.Get	setDataSourceId(String dataSourceId) The data stream ID of the data source that created the dataset.
Fitness.Users.DataSources.Datasets.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Fitness.Users.DataSources.Datasets.Get	setKey(String key) API key.
Fitness.Users.DataSources.Datasets.Get	setLimit(Integer limit) If specified, no more than this many data points will be included in the dataset.
Fitness.Users.DataSources.Datasets.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Fitness.Users.DataSources.Datasets.Get	setPageToken(String pageToken) The continuation token, which is used to page through large datasets.
Fitness.Users.DataSources.Datasets.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Fitness.Users.DataSources.Datasets.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Fitness.Users.DataSources.Datasets.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Fitness.Users.DataSources.Datasets.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Fitness.Users.DataSources.Datasets.Get	setUserId(String userId) Retrieve a dataset for the person identified.

Methods inherited from class com.google.api.services.fitness.FitnessRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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

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

Get

protected Get(String userId,
              String dataSourceId,
              String datasetId)

Returns a dataset containing all data points whose start and end times overlap with the specified range of the dataset minimum start time and maximum end time. Specifically, any data point whose start time is less than or equal to the dataset end time and whose end time is greater than or equal to the dataset start time. Create a request for the method "datasets.get". This request holds the parameters needed by the the fitness server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Fitness.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

userId - Retrieve a dataset 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 that created the dataset.

datasetId - Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime- endTime" where startTime and endTime are 64 bit integers.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Dataset>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Dataset>

Throws:

IOException

set$Xgafv

public Fitness.Users.DataSources.Datasets.Get set$Xgafv(String $Xgafv)

Description copied from class: FitnessRequest

V1 error format.

Overrides:

set$Xgafv in class FitnessRequest<Dataset>

setAccessToken

public Fitness.Users.DataSources.Datasets.Get setAccessToken(String accessToken)

Description copied from class: FitnessRequest

OAuth access token.

Overrides:

setAccessToken in class FitnessRequest<Dataset>

setAlt

public Fitness.Users.DataSources.Datasets.Get setAlt(String alt)

Description copied from class: FitnessRequest

Data format for response.

Overrides:

setAlt in class FitnessRequest<Dataset>

setCallback

public Fitness.Users.DataSources.Datasets.Get setCallback(String callback)

Description copied from class: FitnessRequest

JSONP

Overrides:

setCallback in class FitnessRequest<Dataset>

setFields

public Fitness.Users.DataSources.Datasets.Get setFields(String fields)

Description copied from class: FitnessRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class FitnessRequest<Dataset>

setKey

public Fitness.Users.DataSources.Datasets.Get setKey(String key)

Description copied from class: FitnessRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class FitnessRequest<Dataset>

setOauthToken

public Fitness.Users.DataSources.Datasets.Get setOauthToken(String oauthToken)

Description copied from class: FitnessRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class FitnessRequest<Dataset>

setPrettyPrint

public Fitness.Users.DataSources.Datasets.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: FitnessRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class FitnessRequest<Dataset>

setQuotaUser

public Fitness.Users.DataSources.Datasets.Get setQuotaUser(String quotaUser)

Description copied from class: FitnessRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class FitnessRequest<Dataset>

setUploadType

public Fitness.Users.DataSources.Datasets.Get setUploadType(String uploadType)

Description copied from class: FitnessRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class FitnessRequest<Dataset>

setUploadProtocol

public Fitness.Users.DataSources.Datasets.Get setUploadProtocol(String uploadProtocol)

Description copied from class: FitnessRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class FitnessRequest<Dataset>

getUserId

public String getUserId()

Retrieve a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

setUserId

public Fitness.Users.DataSources.Datasets.Get setUserId(String userId)

Retrieve a dataset for the person identified. Use me to indicate the authenticated user. Only me is supported at this time.

getDataSourceId

public String getDataSourceId()

The data stream ID of the data source that created the dataset.

setDataSourceId

public Fitness.Users.DataSources.Datasets.Get setDataSourceId(String dataSourceId)

The data stream ID of the data source that created the dataset.

getDatasetId

public String getDatasetId()

Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers.

setDatasetId

public Fitness.Users.DataSources.Datasets.Get setDatasetId(String datasetId)

Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: "startTime-endTime" where startTime and endTime are 64 bit integers.

getLimit

public Integer getLimit()

If specified, no more than this many data points will be included in the dataset. If there are more data points in the dataset, nextPageToken will be set in the dataset response. The limit is applied from the end of the time range. That is, if pageToken is absent, the limit most recent data points will be returned.

setLimit

public Fitness.Users.DataSources.Datasets.Get setLimit(Integer limit)

If specified, no more than this many data points will be included in the dataset. If there are more data points in the dataset, nextPageToken will be set in the dataset response. The limit is applied from the end of the time range. That is, if pageToken is absent, the limit most recent data points will be returned.

getPageToken

public String getPageToken()

The continuation token, which is used to page through large datasets. To get the next page of a dataset, set this parameter to the value of nextPageToken from the previous response. Each subsequent call will yield a partial dataset with data point end timestamps that are strictly smaller than those in the previous partial response.

setPageToken

public Fitness.Users.DataSources.Datasets.Get setPageToken(String pageToken)

The continuation token, which is used to page through large datasets. To get the next page of a dataset, set this parameter to the value of nextPageToken from the previous response. Each subsequent call will yield a partial dataset with data point end timestamps that are strictly smaller than those in the previous partial response.

set

public Fitness.Users.DataSources.Datasets.Get set(String parameterName,
                                                  Object value)

Overrides:

set in class FitnessRequest<Dataset>