com.google.api.services.coordinate

Class Coordinate.Location.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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.coordinate.CoordinateRequest<LocationListResponse>

com.google.api.services.coordinate.Coordinate.Location.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Coordinate.Location

public class Coordinate.Location.List
extends CoordinateRequest<LocationListResponse>

Nested Class Summary

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

com.google.api.client.util.GenericData.Flags

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

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

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

java.util.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	Coordinate.Location.List(java.lang.String teamId, java.lang.String workerEmail, java.math.BigInteger startTimestampMs) Retrieves a list of locations for a worker.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.Long	getMaxResults() Maximum number of results to return in one page.
java.lang.String	getPageToken() Continuation token
java.math.BigInteger	getStartTimestampMs() Start timestamp in milliseconds since the epoch.
java.lang.String	getTeamId() Team ID
java.lang.String	getWorkerEmail() Worker email address.
Coordinate.Location.List	set(java.lang.String parameterName, java.lang.Object value)
Coordinate.Location.List	setAlt(java.lang.String alt) Data format for the response.
Coordinate.Location.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Coordinate.Location.List	setKey(java.lang.String key) API key.
Coordinate.Location.List	setMaxResults(java.lang.Long maxResults) Maximum number of results to return in one page.
Coordinate.Location.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Coordinate.Location.List	setPageToken(java.lang.String pageToken) Continuation token
Coordinate.Location.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Coordinate.Location.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Coordinate.Location.List	setStartTimestampMs(java.math.BigInteger startTimestampMs) Start timestamp in milliseconds since the epoch.
Coordinate.Location.List	setTeamId(java.lang.String teamId) Team ID
Coordinate.Location.List	setUserIp(java.lang.String userIp) IP address of the site where the request originates.
Coordinate.Location.List	setWorkerEmail(java.lang.String workerEmail) Worker email address.

Methods inherited from class com.google.api.services.coordinate.CoordinateRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

Coordinate.Location.List

protected Coordinate.Location.List(java.lang.String teamId,
                        java.lang.String workerEmail,
                        java.math.BigInteger startTimestampMs)

Retrieves a list of locations for a worker. Create a request for the method "location.list". This request holds the parameters needed by the the coordinate server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

teamId - Team ID

workerEmail - Worker email address.

startTimestampMs - Start timestamp in milliseconds since the epoch.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LocationListResponse>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LocationListResponse>

Throws:

java.io.IOException

setAlt

public Coordinate.Location.List setAlt(java.lang.String alt)

Description copied from class: CoordinateRequest

Data format for the response.

Overrides:

setAlt in class CoordinateRequest<LocationListResponse>

setFields

public Coordinate.Location.List setFields(java.lang.String fields)

Description copied from class: CoordinateRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CoordinateRequest<LocationListResponse>

setKey

public Coordinate.Location.List setKey(java.lang.String key)

Description copied from class: CoordinateRequest

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 CoordinateRequest<LocationListResponse>

setOauthToken

public Coordinate.Location.List setOauthToken(java.lang.String oauthToken)

Description copied from class: CoordinateRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CoordinateRequest<LocationListResponse>

setPrettyPrint

public Coordinate.Location.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: CoordinateRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CoordinateRequest<LocationListResponse>

setQuotaUser

public Coordinate.Location.List setQuotaUser(java.lang.String quotaUser)

Description copied from class: CoordinateRequest

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 userIp if both are provided.

Overrides:

setQuotaUser in class CoordinateRequest<LocationListResponse>

setUserIp

public Coordinate.Location.List setUserIp(java.lang.String userIp)

Description copied from class: CoordinateRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class CoordinateRequest<LocationListResponse>

getTeamId

public java.lang.String getTeamId()

Team ID

setTeamId

public Coordinate.Location.List setTeamId(java.lang.String teamId)

Team ID

getWorkerEmail

public java.lang.String getWorkerEmail()

Worker email address.

setWorkerEmail

public Coordinate.Location.List setWorkerEmail(java.lang.String workerEmail)

Worker email address.

getStartTimestampMs

public java.math.BigInteger getStartTimestampMs()

Start timestamp in milliseconds since the epoch.

setStartTimestampMs

public Coordinate.Location.List setStartTimestampMs(java.math.BigInteger startTimestampMs)

Start timestamp in milliseconds since the epoch.

getMaxResults

public java.lang.Long getMaxResults()

Maximum number of results to return in one page.

setMaxResults

public Coordinate.Location.List setMaxResults(java.lang.Long maxResults)

Maximum number of results to return in one page.

getPageToken

public java.lang.String getPageToken()

Continuation token

setPageToken

public Coordinate.Location.List setPageToken(java.lang.String pageToken)

Continuation token

set

public Coordinate.Location.List set(java.lang.String parameterName,
                           java.lang.Object value)

Overrides:

set in class CoordinateRequest<LocationListResponse>