com.google.api.services.analyticsdata.v1beta.model

Class CheckCompatibilityRequest

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.CheckCompatibilityRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the `runReport` request should be the same values as in your `runReport` request.

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
CheckCompatibilityRequest()

Method Summary

Modifier and Type	Method and Description
CheckCompatibilityRequest	clone()
String	getCompatibilityFilter() Filters the dimensions and metrics in the response to just this compatibility.
FilterExpression	getDimensionFilter() The filter clause of dimensions.
List<Dimension>	getDimensions() The dimensions in this report.
FilterExpression	getMetricFilter() The filter clause of metrics.
List<Metric>	getMetrics() The metrics in this report.
CheckCompatibilityRequest	set(String fieldName, Object value)
CheckCompatibilityRequest	setCompatibilityFilter(String compatibilityFilter) Filters the dimensions and metrics in the response to just this compatibility.
CheckCompatibilityRequest	setDimensionFilter(FilterExpression dimensionFilter) The filter clause of dimensions.
CheckCompatibilityRequest	setDimensions(List<Dimension> dimensions) The dimensions in this report.
CheckCompatibilityRequest	setMetricFilter(FilterExpression metricFilter) The filter clause of metrics.
CheckCompatibilityRequest	setMetrics(List<Metric> metrics) The metrics in this report.

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

CheckCompatibilityRequest

public CheckCompatibilityRequest()

Method Detail

getCompatibilityFilter

public String getCompatibilityFilter()

Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return compatible dimensions & metrics.

Returns:

value or null for none

setCompatibilityFilter

public CheckCompatibilityRequest setCompatibilityFilter(String compatibilityFilter)

Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return compatible dimensions & metrics.

Parameters:

compatibilityFilter - compatibilityFilter or null for none

getDimensionFilter

public FilterExpression getDimensionFilter()

The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request.

Returns:

value or null for none

setDimensionFilter

public CheckCompatibilityRequest setDimensionFilter(FilterExpression dimensionFilter)

The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request.

Parameters:

dimensionFilter - dimensionFilter or null for none

getDimensions

public List<Dimension> getDimensions()

The dimensions in this report. `dimensions` should be the same value as in your `runReport` request.

Returns:

value or null for none

setDimensions

public CheckCompatibilityRequest setDimensions(List<Dimension> dimensions)

The dimensions in this report. `dimensions` should be the same value as in your `runReport` request.

Parameters:

dimensions - dimensions or null for none

getMetricFilter

public FilterExpression getMetricFilter()

The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request

Returns:

value or null for none

setMetricFilter

public CheckCompatibilityRequest setMetricFilter(FilterExpression metricFilter)

The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request

Parameters:

metricFilter - metricFilter or null for none

getMetrics

public List<Metric> getMetrics()

The metrics in this report. `metrics` should be the same value as in your `runReport` request.

Returns:

value or null for none

setMetrics

public CheckCompatibilityRequest setMetrics(List<Metric> metrics)

The metrics in this report. `metrics` should be the same value as in your `runReport` request.

Parameters:

metrics - metrics or null for none

set

public CheckCompatibilityRequest set(String fieldName,
                                     Object value)

Overrides:

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

clone

public CheckCompatibilityRequest clone()

Overrides:

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