RunRealtimeReportRequest (Google Analytics Data API v1beta-rev20230214-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.analyticsdata.v1beta.model.RunRealtimeReportRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class RunRealtimeReportRequest
extends com.google.api.client.json.GenericJson
```
The request to generate a realtime report.
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 Data 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
  com.google.api.client.util.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

RunRealtimeReportRequest()

Constructors
Constructor and Description
`RunRealtimeReportRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RunRealtimeReportRequest`	`clone()`
`FilterExpression`	`getDimensionFilter()` The filter clause of dimensions.
`List<Dimension>`	`getDimensions()` The dimensions requested and displayed.
`Long`	`getLimit()` The number of rows to return.
`List<String>`	`getMetricAggregations()` Aggregation of metrics.
`FilterExpression`	`getMetricFilter()` The filter clause of metrics.
`List<Metric>`	`getMetrics()` The metrics requested and displayed.
`List<MinuteRange>`	`getMinuteRanges()` The minute ranges of event data to read.
`List<OrderBy>`	`getOrderBys()` Specifies how rows are ordered in the response.
`Boolean`	`getReturnPropertyQuota()` Toggles whether to return the current state of this Analytics Property's Realtime quota.
`RunRealtimeReportRequest`	`set(String fieldName, Object value)`
`RunRealtimeReportRequest`	`setDimensionFilter(FilterExpression dimensionFilter)` The filter clause of dimensions.
`RunRealtimeReportRequest`	`setDimensions(List<Dimension> dimensions)` The dimensions requested and displayed.
`RunRealtimeReportRequest`	`setLimit(Long limit)` The number of rows to return.
`RunRealtimeReportRequest`	`setMetricAggregations(List<String> metricAggregations)` Aggregation of metrics.
`RunRealtimeReportRequest`	`setMetricFilter(FilterExpression metricFilter)` The filter clause of metrics.
`RunRealtimeReportRequest`	`setMetrics(List<Metric> metrics)` The metrics requested and displayed.
`RunRealtimeReportRequest`	`setMinuteRanges(List<MinuteRange> minuteRanges)` The minute ranges of event data to read.
`RunRealtimeReportRequest`	`setOrderBys(List<OrderBy> orderBys)` Specifies how rows are ordered in the response.
`RunRealtimeReportRequest`	`setReturnPropertyQuota(Boolean returnPropertyQuota)` Toggles whether to return the current state of this Analytics Property's Realtime quota.

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
  - RunRealtimeReportRequest
```
public RunRealtimeReportRequest()
```
- Method Detail
  - getDimensionFilter
```
public FilterExpression getDimensionFilter()
```
    The filter clause of dimensions. Metrics cannot be used in this filter.
    
    Returns:
    
    value or null for none
  - setDimensionFilter
```
public RunRealtimeReportRequest setDimensionFilter(FilterExpression dimensionFilter)
```
    The filter clause of dimensions. Metrics cannot be used in this filter.
    
    Parameters:
    
    dimensionFilter - dimensionFilter or null for none
  - getDimensions
```
public List<Dimension> getDimensions()
```
    The dimensions requested and displayed.
    
    Returns:
    
    value or null for none
  - setDimensions
```
public RunRealtimeReportRequest setDimensions(List<Dimension> dimensions)
```
    The dimensions requested and displayed.
    
    Parameters:
    
    dimensions - dimensions or null for none
  - getLimit
```
public Long getLimit()
```
    The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value.
    
    Returns:
    
    value or null for none
  - setLimit
```
public RunRealtimeReportRequest setLimit(Long limit)
```
    The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value.
    
    Parameters:
    
    limit - limit or null for none
  - getMetricAggregations
```
public List<String> getMetricAggregations()
```
    Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
    
    Returns:
    
    value or null for none
  - setMetricAggregations
```
public RunRealtimeReportRequest setMetricAggregations(List<String> metricAggregations)
```
    Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)".
    
    Parameters:
    
    metricAggregations - metricAggregations or null for none
  - getMetricFilter
```
public FilterExpression getMetricFilter()
```
    The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.
    
    Returns:
    
    value or null for none
  - setMetricFilter
```
public RunRealtimeReportRequest setMetricFilter(FilterExpression metricFilter)
```
    The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.
    
    Parameters:
    
    metricFilter - metricFilter or null for none
  - getMetrics
```
public List<Metric> getMetrics()
```
    The metrics requested and displayed.
    
    Returns:
    
    value or null for none
  - setMetrics
```
public RunRealtimeReportRequest setMetrics(List<Metric> metrics)
```
    The metrics requested and displayed.
    
    Parameters:
    
    metrics - metrics or null for none
  - getMinuteRanges
```
public List<MinuteRange> getMinuteRanges()
```
    The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.
    
    Returns:
    
    value or null for none
  - setMinuteRanges
```
public RunRealtimeReportRequest setMinuteRanges(List<MinuteRange> minuteRanges)
```
    The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.
    
    Parameters:
    
    minuteRanges - minuteRanges or null for none
  - getOrderBys
```
public List<OrderBy> getOrderBys()
```
    Specifies how rows are ordered in the response.
    
    Returns:
    
    value or null for none
  - setOrderBys
```
public RunRealtimeReportRequest setOrderBys(List<OrderBy> orderBys)
```
    Specifies how rows are ordered in the response.
    
    Parameters:
    
    orderBys - orderBys or null for none
  - getReturnPropertyQuota
```
public Boolean getReturnPropertyQuota()
```
    Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
    
    Returns:
    
    value or null for none
  - setReturnPropertyQuota
```
public RunRealtimeReportRequest setReturnPropertyQuota(Boolean returnPropertyQuota)
```
    Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
    
    Parameters:
    
    returnPropertyQuota - returnPropertyQuota or null for none
  - set
```
public RunRealtimeReportRequest set(String fieldName,
                                    Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public RunRealtimeReportRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class RunRealtimeReportRequest

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

RunRealtimeReportRequest

Method Detail

getDimensionFilter

setDimensionFilter

getDimensions

setDimensions

getLimit

setLimit

getMetricAggregations

setMetricAggregations

getMetricFilter

setMetricFilter

getMetrics

setMetrics

getMinuteRanges

setMinuteRanges

getOrderBys

setOrderBys

getReturnPropertyQuota

setReturnPropertyQuota

set

clone