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

Class DimensionFilter

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DimensionFilter
extends GenericJson

Dimension filter specifies the filtering options on a dimension.

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

Method Summary

Modifier and Type	Method and Description
DimensionFilter	clone()
Boolean	getCaseSensitive() Should the match be case sensitive? Default is false.
String	getDimensionName() The dimension to filter on.
List<String>	getExpressions() Strings or regular expression to match against.
Boolean	getNot() Logical `NOT` operator.
String	getOperator() How to match the dimension to the expression.
DimensionFilter	set(String fieldName, Object value)
DimensionFilter	setCaseSensitive(Boolean caseSensitive) Should the match be case sensitive? Default is false.
DimensionFilter	setDimensionName(String dimensionName) The dimension to filter on.
DimensionFilter	setExpressions(List<String> expressions) Strings or regular expression to match against.
DimensionFilter	setNot(Boolean not) Logical `NOT` operator.
DimensionFilter	setOperator(String operator) How to match the dimension to the expression.

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

DimensionFilter

public DimensionFilter()

Method Detail

getCaseSensitive

public Boolean getCaseSensitive()

Should the match be case sensitive? Default is false.

Returns:

value or null for none

setCaseSensitive

public DimensionFilter setCaseSensitive(Boolean caseSensitive)

Should the match be case sensitive? Default is false.

Parameters:

caseSensitive - caseSensitive or null for none

getDimensionName

public String getDimensionName()

The dimension to filter on. A DimensionFilter must contain a dimension.

Returns:

value or null for none

setDimensionName

public DimensionFilter setDimensionName(String dimensionName)

The dimension to filter on. A DimensionFilter must contain a dimension.

Parameters:

dimensionName - dimensionName or null for none

getExpressions

public List<String> getExpressions()

Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST` operator, then the entire list is used to filter the dimensions as explained in the description of the `IN_LIST` operator.

Returns:

value or null for none

setExpressions

public DimensionFilter setExpressions(List<String> expressions)

Strings or regular expression to match against. Only the first value of the list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST` operator, then the entire list is used to filter the dimensions as explained in the description of the `IN_LIST` operator.

Parameters:

expressions - expressions or null for none

getNot

public Boolean getNot()

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

Returns:

value or null for none

setNot

public DimensionFilter setNot(Boolean not)

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

Parameters:

not - not or null for none

getOperator

public String getOperator()

How to match the dimension to the expression. The default is REGEXP.

Returns:

value or null for none

setOperator

public DimensionFilter setOperator(String operator)

How to match the dimension to the expression. The default is REGEXP.

Parameters:

operator - operator or null for none

set

public DimensionFilter set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public DimensionFilter clone()

Overrides:

clone in class GenericJson