com.google.api.services.analytics.model

Class RealtimeData

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analytics.model.RealtimeData

All Implemented Interfaces:

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

public final class RealtimeData
extends com.google.api.client.json.GenericJson

Real time data for a given view (profile).

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 Google Analytics API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RealtimeData.ColumnHeaders Model definition for RealtimeDataColumnHeaders.
static class	RealtimeData.ProfileInfo Information for the view (profile), for which the real time data was requested.
static class	RealtimeData.Query Real time data request query parameters.

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>

Constructor Summary

Constructors

Constructor and Description
RealtimeData()

Method Summary

Methods

Modifier and Type	Method and Description
RealtimeData	clone()
java.util.List<RealtimeData.ColumnHeaders>	getColumnHeaders() Column headers that list dimension names followed by the metric names.
java.lang.String	getId() Unique ID for this data response.
java.lang.String	getKind() Resource type.
RealtimeData.ProfileInfo	getProfileInfo() Information for the view (profile), for which the real time data was requested.
RealtimeData.Query	getQuery() Real time data request query parameters.
java.util.List<java.util.List<java.lang.String>>	getRows() Real time data rows, where each row contains a list of dimension values followed by the metric values.
java.lang.String	getSelfLink() Link to this page.
java.lang.Integer	getTotalResults() The total number of rows for the query, regardless of the number of rows in the response.
java.util.Map<java.lang.String,java.lang.String>	getTotalsForAllResults() Total values for the requested metrics over all the results, not just the results returned in this response.
RealtimeData	set(java.lang.String fieldName, java.lang.Object value)
RealtimeData	setColumnHeaders(java.util.List<RealtimeData.ColumnHeaders> columnHeaders) Column headers that list dimension names followed by the metric names.
RealtimeData	setId(java.lang.String id) Unique ID for this data response.
RealtimeData	setKind(java.lang.String kind) Resource type.
RealtimeData	setProfileInfo(RealtimeData.ProfileInfo profileInfo) Information for the view (profile), for which the real time data was requested.
RealtimeData	setQuery(RealtimeData.Query query) Real time data request query parameters.
RealtimeData	setRows(java.util.List<java.util.List<java.lang.String>> rows) Real time data rows, where each row contains a list of dimension values followed by the metric values.
RealtimeData	setSelfLink(java.lang.String selfLink) Link to this page.
RealtimeData	setTotalResults(java.lang.Integer totalResults) The total number of rows for the query, regardless of the number of rows in the response.
RealtimeData	setTotalsForAllResults(java.util.Map<java.lang.String,java.lang.String> totalsForAllResults) Total values for the requested metrics over all the results, not just the results returned in this response.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RealtimeData

public RealtimeData()

Method Detail

getColumnHeaders

public java.util.List<RealtimeData.ColumnHeaders> getColumnHeaders()

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

Returns:

value or null for none

setColumnHeaders

public RealtimeData setColumnHeaders(java.util.List<RealtimeData.ColumnHeaders> columnHeaders)

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.

Parameters:

columnHeaders - columnHeaders or null for none

getId

public java.lang.String getId()

Unique ID for this data response.

Returns:

value or null for none

setId

public RealtimeData setId(java.lang.String id)

Unique ID for this data response.

Parameters:

id - id or null for none

getKind

public java.lang.String getKind()

Resource type.

Returns:

value or null for none

setKind

public RealtimeData setKind(java.lang.String kind)

Resource type.

Parameters:

kind - kind or null for none

getProfileInfo

public RealtimeData.ProfileInfo getProfileInfo()

Information for the view (profile), for which the real time data was requested.

Returns:

value or null for none

setProfileInfo

public RealtimeData setProfileInfo(RealtimeData.ProfileInfo profileInfo)

Information for the view (profile), for which the real time data was requested.

Parameters:

profileInfo - profileInfo or null for none

getQuery

public RealtimeData.Query getQuery()

Real time data request query parameters.

Returns:

value or null for none

setQuery

public RealtimeData setQuery(RealtimeData.Query query)

Real time data request query parameters.

Parameters:

query - query or null for none

getRows

public java.util.List<java.util.List<java.lang.String>> getRows()

Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

Returns:

value or null for none

setRows

public RealtimeData setRows(java.util.List<java.util.List<java.lang.String>> rows)

Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.

Parameters:

rows - rows or null for none

getSelfLink

public java.lang.String getSelfLink()

Link to this page.

Returns:

value or null for none

setSelfLink

public RealtimeData setSelfLink(java.lang.String selfLink)

Link to this page.

Parameters:

selfLink - selfLink or null for none

getTotalResults

public java.lang.Integer getTotalResults()

The total number of rows for the query, regardless of the number of rows in the response.

Returns:

value or null for none

setTotalResults

public RealtimeData setTotalResults(java.lang.Integer totalResults)

The total number of rows for the query, regardless of the number of rows in the response.

Parameters:

totalResults - totalResults or null for none

getTotalsForAllResults

public java.util.Map<java.lang.String,java.lang.String> getTotalsForAllResults()

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

Returns:

value or null for none

setTotalsForAllResults

public RealtimeData setTotalsForAllResults(java.util.Map<java.lang.String,java.lang.String> totalsForAllResults)

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.

Parameters:

totalsForAllResults - totalsForAllResults or null for none

set

public RealtimeData set(java.lang.String fieldName,
               java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public RealtimeData clone()

Overrides:

clone in class com.google.api.client.json.GenericJson