com.google.api.services.gmail.model

Class Filter

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.gmail.model.Filter

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.

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 Gmail 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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Filter()

Method Summary

Modifier and Type	Method and Description
Filter	clone()
FilterAction	getAction() Action that the filter performs.
FilterCriteria	getCriteria() Matching criteria for the filter.
java.lang.String	getId() The server assigned ID of the filter.
Filter	set(java.lang.String fieldName, java.lang.Object value)
Filter	setAction(FilterAction action) Action that the filter performs.
Filter	setCriteria(FilterCriteria criteria) Matching criteria for the filter.
Filter	setId(java.lang.String id) The server assigned ID of the filter.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, 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

Filter

public Filter()

Method Detail

getAction

public FilterAction getAction()

Action that the filter performs.

Returns:

value or null for none

setAction

public Filter setAction(FilterAction action)

Action that the filter performs.

Parameters:

action - action or null for none

getCriteria

public FilterCriteria getCriteria()

Matching criteria for the filter.

Returns:

value or null for none

setCriteria

public Filter setCriteria(FilterCriteria criteria)

Matching criteria for the filter.

Parameters:

criteria - criteria or null for none

getId

public java.lang.String getId()

The server assigned ID of the filter.

Returns:

value or null for none

setId

public Filter setId(java.lang.String id)

The server assigned ID of the filter.

Parameters:

id - id or null for none

set

public Filter set(java.lang.String fieldName,
                  java.lang.Object value)

Overrides:

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

clone

public Filter clone()

Overrides:

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