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

Class SegmentMetricFilter

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SegmentMetricFilter
extends GenericJson

Metric filter to be used in a segment filter clause.

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

Method Summary

Modifier and Type	Method and Description
SegmentMetricFilter	clone()
String	getComparisonValue() The value to compare against.
String	getMaxComparisonValue() Max comparison value is only used for `BETWEEN` operator.
String	getMetricName() The metric that will be filtered on.
String	getOperator() Specifies is the operation to perform to compare the metric.
String	getScope() Scope for a metric defines the level at which that metric is defined.
SegmentMetricFilter	set(String fieldName, Object value)
SegmentMetricFilter	setComparisonValue(String comparisonValue) The value to compare against.
SegmentMetricFilter	setMaxComparisonValue(String maxComparisonValue) Max comparison value is only used for `BETWEEN` operator.
SegmentMetricFilter	setMetricName(String metricName) The metric that will be filtered on.
SegmentMetricFilter	setOperator(String operator) Specifies is the operation to perform to compare the metric.
SegmentMetricFilter	setScope(String scope) Scope for a metric defines the level at which that metric is defined.

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

SegmentMetricFilter

public SegmentMetricFilter()

Method Detail

getComparisonValue

public String getComparisonValue()

The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value.

Returns:

value or null for none

setComparisonValue

public SegmentMetricFilter setComparisonValue(String comparisonValue)

The value to compare against. If the operator is `BETWEEN`, this value is treated as minimum comparison value.

Parameters:

comparisonValue - comparisonValue or null for none

getMaxComparisonValue

public String getMaxComparisonValue()

Max comparison value is only used for `BETWEEN` operator.

Returns:

value or null for none

setMaxComparisonValue

public SegmentMetricFilter setMaxComparisonValue(String maxComparisonValue)

Max comparison value is only used for `BETWEEN` operator.

Parameters:

maxComparisonValue - maxComparisonValue or null for none

getMetricName

public String getMetricName()

The metric that will be filtered on. A `metricFilter` must contain a metric name.

Returns:

value or null for none

setMetricName

public SegmentMetricFilter setMetricName(String metricName)

The metric that will be filtered on. A `metricFilter` must contain a metric name.

Parameters:

metricName - metricName or null for none

getOperator

public String getOperator()

Specifies is the operation to perform to compare the metric. The default is `EQUAL`.

Returns:

value or null for none

setOperator

public SegmentMetricFilter setOperator(String operator)

Specifies is the operation to perform to compare the metric. The default is `EQUAL`.

Parameters:

operator - operator or null for none

getScope

public String getScope()

Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The primary scope is defined by if the segment is selecting users or sessions.

Returns:

value or null for none

setScope

public SegmentMetricFilter setScope(String scope)

Scope for a metric defines the level at which that metric is defined. The specified metric scope must be equal to or greater than its primary scope as defined in the data model. The primary scope is defined by if the segment is selecting users or sessions.

Parameters:

scope - scope or null for none

set

public SegmentMetricFilter set(String fieldName,
                               Object value)

Overrides:

set in class GenericJson

clone

public SegmentMetricFilter clone()

Overrides:

clone in class GenericJson