TrafficStats (Gmail Postmaster Tools API v1beta1-rev20250529-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.gmailpostmastertools.v1beta1.model.TrafficStats

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TrafficStats
extends com.google.api.client.json.GenericJson
```
Email traffic statistics pertaining to a specific date.
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 Postmaster Tools 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

TrafficStats()

Constructors
Constructor and Description
`TrafficStats()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TrafficStats`	`clone()`
`List<DeliveryError>`	`getDeliveryErrors()` Delivery errors for the domain.
`Double`	`getDkimSuccessRatio()` The ratio of mail that successfully authenticated with DKIM vs.
`Double`	`getDmarcSuccessRatio()` The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
`String`	`getDomainReputation()` Reputation of the domain.
`Double`	`getInboundEncryptionRatio()` The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain.
`List<IpReputation>`	`getIpReputations()` Reputation information pertaining to the IP addresses of the email servers for the domain.
`String`	`getName()` The resource name of the traffic statistics.
`Double`	`getOutboundEncryptionRatio()` The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
`List<FeedbackLoop>`	`getSpammyFeedbackLoops()` Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates.
`Double`	`getSpfSuccessRatio()` The ratio of mail that successfully authenticated with SPF vs.
`Double`	`getUserReportedSpamRatio()` The ratio of user-report spam vs.
`Double`	`getUserReportedSpamRatioLowerBound()` The lower bound of the confidence interval for the user reported spam ratio.
`Double`	`getUserReportedSpamRatioUpperBound()` The upper bound of the confidence interval for the user reported spam ratio.
`TrafficStats`	`set(String fieldName, Object value)`
`TrafficStats`	`setDeliveryErrors(List<DeliveryError> deliveryErrors)` Delivery errors for the domain.
`TrafficStats`	`setDkimSuccessRatio(Double dkimSuccessRatio)` The ratio of mail that successfully authenticated with DKIM vs.
`TrafficStats`	`setDmarcSuccessRatio(Double dmarcSuccessRatio)` The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
`TrafficStats`	`setDomainReputation(String domainReputation)` Reputation of the domain.
`TrafficStats`	`setInboundEncryptionRatio(Double inboundEncryptionRatio)` The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain.
`TrafficStats`	`setIpReputations(List<IpReputation> ipReputations)` Reputation information pertaining to the IP addresses of the email servers for the domain.
`TrafficStats`	`setName(String name)` The resource name of the traffic statistics.
`TrafficStats`	`setOutboundEncryptionRatio(Double outboundEncryptionRatio)` The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
`TrafficStats`	`setSpammyFeedbackLoops(List<FeedbackLoop> spammyFeedbackLoops)` Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates.
`TrafficStats`	`setSpfSuccessRatio(Double spfSuccessRatio)` The ratio of mail that successfully authenticated with SPF vs.
`TrafficStats`	`setUserReportedSpamRatio(Double userReportedSpamRatio)` The ratio of user-report spam vs.
`TrafficStats`	`setUserReportedSpamRatioLowerBound(Double userReportedSpamRatioLowerBound)` The lower bound of the confidence interval for the user reported spam ratio.
`TrafficStats`	`setUserReportedSpamRatioUpperBound(Double userReportedSpamRatioUpperBound)` The upper bound of the confidence interval for the user reported spam ratio.

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
  - TrafficStats
```
public TrafficStats()
```
- Method Detail
  - getDeliveryErrors
```
public List<DeliveryError> getDeliveryErrors()
```
    Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
    
    Returns:
    
    value or null for none
  - setDeliveryErrors
```
public TrafficStats setDeliveryErrors(List<DeliveryError> deliveryErrors)
```
    Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
    
    Parameters:
    
    deliveryErrors - deliveryErrors or null for none
  - getDkimSuccessRatio
```
public Double getDkimSuccessRatio()
```
    The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is excluded.
    
    Returns:
    
    value or null for none
  - setDkimSuccessRatio
```
public TrafficStats setDkimSuccessRatio(Double dkimSuccessRatio)
```
    The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is excluded.
    
    Parameters:
    
    dkimSuccessRatio - dkimSuccessRatio or null for none
  - getDmarcSuccessRatio
```
public Double getDmarcSuccessRatio()
```
    The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
    
    Returns:
    
    value or null for none
  - setDmarcSuccessRatio
```
public TrafficStats setDmarcSuccessRatio(Double dmarcSuccessRatio)
```
    The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
    
    Parameters:
    
    dmarcSuccessRatio - dmarcSuccessRatio or null for none
  - getDomainReputation
```
public String getDomainReputation()
```
    Reputation of the domain.
    
    Returns:
    
    value or null for none
  - setDomainReputation
```
public TrafficStats setDomainReputation(String domainReputation)
```
    Reputation of the domain.
    
    Parameters:
    
    domainReputation - domainReputation or null for none
  - getInboundEncryptionRatio
```
public Double getInboundEncryptionRatio()
```
    The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
    
    Returns:
    
    value or null for none
  - setInboundEncryptionRatio
```
public TrafficStats setInboundEncryptionRatio(Double inboundEncryptionRatio)
```
    The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
    
    Parameters:
    
    inboundEncryptionRatio - inboundEncryptionRatio or null for none
  - getIpReputations
```
public List<IpReputation> getIpReputations()
```
    Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except REPUTATION_CATEGORY_UNSPECIFIED.
    
    Returns:
    
    value or null for none
  - setIpReputations
```
public TrafficStats setIpReputations(List<IpReputation> ipReputations)
```
    Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except REPUTATION_CATEGORY_UNSPECIFIED.
    
    Parameters:
    
    ipReputations - ipReputations or null for none
  - getName
```
public String getName()
```
    The resource name of the traffic statistics. Traffic statistic names have the form `domains/{domain}/trafficStats/{date}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic statistics pertains to and date is the date in yyyymmdd format that these statistics corresponds to. For example: domains/mymail.mydomain.com/trafficStats/20160807
    
    Returns:
    
    value or null for none
  - setName
```
public TrafficStats setName(String name)
```
    The resource name of the traffic statistics. Traffic statistic names have the form `domains/{domain}/trafficStats/{date}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic statistics pertains to and date is the date in yyyymmdd format that these statistics corresponds to. For example: domains/mymail.mydomain.com/trafficStats/20160807
    
    Parameters:
    
    name - name or null for none
  - getOutboundEncryptionRatio
```
public Double getOutboundEncryptionRatio()
```
    The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
    
    Returns:
    
    value or null for none
  - setOutboundEncryptionRatio
```
public TrafficStats setOutboundEncryptionRatio(Double outboundEncryptionRatio)
```
    The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
    
    Parameters:
    
    outboundEncryptionRatio - outboundEncryptionRatio or null for none
  - getSpammyFeedbackLoops
```
public List<FeedbackLoop> getSpammyFeedbackLoops()
```
    Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates. This metric only pertains to traffic that is authenticated by [DKIM](http://www.dkim.org/).
    
    Returns:
    
    value or null for none
  - setSpammyFeedbackLoops
```
public TrafficStats setSpammyFeedbackLoops(List<FeedbackLoop> spammyFeedbackLoops)
```
    Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates. This metric only pertains to traffic that is authenticated by [DKIM](http://www.dkim.org/).
    
    Parameters:
    
    spammyFeedbackLoops - spammyFeedbackLoops or null for none
  - getSpfSuccessRatio
```
public Double getSpfSuccessRatio()
```
    The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is excluded.
    
    Returns:
    
    value or null for none
  - setSpfSuccessRatio
```
public TrafficStats setSpfSuccessRatio(Double spfSuccessRatio)
```
    The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is excluded.
    
    Parameters:
    
    spfSuccessRatio - spfSuccessRatio or null for none
  - getUserReportedSpamRatio
```
public Double getUserReportedSpamRatio()
```
    The ratio of user-report spam vs. email that was sent to the inbox. This is potentially inexact -- users may want to refer to the description of the interval fields userReportedSpamRatioLowerBound and userReportedSpamRatioUpperBound for more explicit accuracy guarantees. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
    
    Returns:
    
    value or null for none
  - setUserReportedSpamRatio
```
public TrafficStats setUserReportedSpamRatio(Double userReportedSpamRatio)
```
    The ratio of user-report spam vs. email that was sent to the inbox. This is potentially inexact -- users may want to refer to the description of the interval fields userReportedSpamRatioLowerBound and userReportedSpamRatioUpperBound for more explicit accuracy guarantees. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
    
    Parameters:
    
    userReportedSpamRatio - userReportedSpamRatio or null for none
  - getUserReportedSpamRatioLowerBound
```
public Double getUserReportedSpamRatioLowerBound()
```
    The lower bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this lower bound and the corresponding upper bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
    
    Returns:
    
    value or null for none
  - setUserReportedSpamRatioLowerBound
```
public TrafficStats setUserReportedSpamRatioLowerBound(Double userReportedSpamRatioLowerBound)
```
    The lower bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this lower bound and the corresponding upper bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
    
    Parameters:
    
    userReportedSpamRatioLowerBound - userReportedSpamRatioLowerBound or null for none
  - getUserReportedSpamRatioUpperBound
```
public Double getUserReportedSpamRatioUpperBound()
```
    The upper bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this upper bound and the corresponding lower bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
    
    Returns:
    
    value or null for none
  - setUserReportedSpamRatioUpperBound
```
public TrafficStats setUserReportedSpamRatioUpperBound(Double userReportedSpamRatioUpperBound)
```
    The upper bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this upper bound and the corresponding lower bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
    
    Parameters:
    
    userReportedSpamRatioUpperBound - userReportedSpamRatioUpperBound or null for none
  - set
```
public TrafficStats set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TrafficStats clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class TrafficStats

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

TrafficStats

Method Detail

getDeliveryErrors

setDeliveryErrors

getDkimSuccessRatio

setDkimSuccessRatio

getDmarcSuccessRatio

setDmarcSuccessRatio

getDomainReputation

setDomainReputation

getInboundEncryptionRatio

setInboundEncryptionRatio

getIpReputations

setIpReputations

getName

setName

getOutboundEncryptionRatio

setOutboundEncryptionRatio

getSpammyFeedbackLoops

setSpammyFeedbackLoops

getSpfSuccessRatio

setSpfSuccessRatio

getUserReportedSpamRatio

setUserReportedSpamRatio

getUserReportedSpamRatioLowerBound

setUserReportedSpamRatioLowerBound

getUserReportedSpamRatioUpperBound

setUserReportedSpamRatioUpperBound

set

clone