com.google.api.services.analyticsreporting.v4.model

Class MetricFilter

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsreporting.v4.model.MetricFilter

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class MetricFilter
extends GenericJson

MetricFilter specifies the filter on a metric.

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 Analytics Reporting 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

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

Method Summary

Modifier and Type	Method and Description
MetricFilter	clone()
String	getComparisonValue() The value to compare against.
String	getMetricName() The metric that will be filtered on.
Boolean	getNot() Logical `NOT` operator.
String	getOperator() Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`.
MetricFilter	set(String fieldName, Object value)
MetricFilter	setComparisonValue(String comparisonValue) The value to compare against.
MetricFilter	setMetricName(String metricName) The metric that will be filtered on.
MetricFilter	setNot(Boolean not) Logical `NOT` operator.
MetricFilter	setOperator(String operator) Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`.

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

MetricFilter

public MetricFilter()

Method Detail

getComparisonValue

public String getComparisonValue()

The value to compare against.

Returns:

value or null for none

setComparisonValue

public MetricFilter setComparisonValue(String comparisonValue)

The value to compare against.

Parameters:

comparisonValue - comparisonValue or null for none

getMetricName

public String getMetricName()

The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression.

Returns:

value or null for none

setMetricName

public MetricFilter setMetricName(String metricName)

The metric that will be filtered on. A metricFilter must contain a metric name. A metric name can be an alias earlier defined as a metric or it can also be a metric expression.

Parameters:

metricName - metricName or null for none

getNot

public Boolean getNot()

Logical `NOT` operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false.

Returns:

value or null for none

setNot

public MetricFilter setNot(Boolean not)

Logical `NOT` operator. If this boolean is set to true, then the matching metric values will be excluded in the report. The default is false.

Parameters:

not - not or null for none

getOperator

public String getOperator()

Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is missing and would ignore the comparisonValue.

Returns:

value or null for none

setOperator

public MetricFilter setOperator(String operator)

Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is missing and would ignore the comparisonValue.

Parameters:

operator - operator or null for none

set

public MetricFilter set(String fieldName,
                        Object value)

Overrides:

set in class GenericJson

clone

public MetricFilter clone()

Overrides:

clone in class GenericJson