PostmasterTools.Domains.TrafficStats.List (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.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.gmailpostmastertools.v1beta1.PostmasterToolsRequest<ListTrafficStatsResponse>
        
        com.google.api.services.gmailpostmastertools.v1beta1.PostmasterTools.Domains.TrafficStats.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: PostmasterTools.Domains.TrafficStats

public class PostmasterTools.Domains.TrafficStats.List
extends PostmasterToolsRequest<ListTrafficStatsResponse>

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String parent)
List traffic statistics for all available days.

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` List traffic statistics for all available days.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`Integer`	`getEndDateDay()` Day of a month.
`Integer`	`getEndDateMonth()` Month of a year.
`Integer`	`getEndDateYear()` Year of the date.
`Integer`	`getPageSize()` Requested page size.
`String`	`getPageToken()` The next_page_token value returned from a previous List request, if any.
`String`	`getParent()` The resource name of the domain whose traffic statistics we'd like to list.
`Integer`	`getStartDateDay()` Day of a month.
`Integer`	`getStartDateMonth()` Month of a year.
`Integer`	`getStartDateYear()` Year of the date.
`PostmasterTools.Domains.TrafficStats.List`	`set(String parameterName, Object value)`
`PostmasterTools.Domains.TrafficStats.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`PostmasterTools.Domains.TrafficStats.List`	`setAccessToken(String accessToken)` OAuth access token.
`PostmasterTools.Domains.TrafficStats.List`	`setAlt(String alt)` Data format for response.
`PostmasterTools.Domains.TrafficStats.List`	`setCallback(String callback)` JSONP
`PostmasterTools.Domains.TrafficStats.List`	`setEndDateDay(Integer endDateDay)` Day of a month.
`PostmasterTools.Domains.TrafficStats.List`	`setEndDateMonth(Integer endDateMonth)` Month of a year.
`PostmasterTools.Domains.TrafficStats.List`	`setEndDateYear(Integer endDateYear)` Year of the date.
`PostmasterTools.Domains.TrafficStats.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`PostmasterTools.Domains.TrafficStats.List`	`setKey(String key)` API key.
`PostmasterTools.Domains.TrafficStats.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`PostmasterTools.Domains.TrafficStats.List`	`setPageSize(Integer pageSize)` Requested page size.
`PostmasterTools.Domains.TrafficStats.List`	`setPageToken(String pageToken)` The next_page_token value returned from a previous List request, if any.
`PostmasterTools.Domains.TrafficStats.List`	`setParent(String parent)` The resource name of the domain whose traffic statistics we'd like to list.
`PostmasterTools.Domains.TrafficStats.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`PostmasterTools.Domains.TrafficStats.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`PostmasterTools.Domains.TrafficStats.List`	`setStartDateDay(Integer startDateDay)` Day of a month.
`PostmasterTools.Domains.TrafficStats.List`	`setStartDateMonth(Integer startDateMonth)` Month of a year.
`PostmasterTools.Domains.TrafficStats.List`	`setStartDateYear(Integer startDateYear)` Year of the date.
`PostmasterTools.Domains.TrafficStats.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`PostmasterTools.Domains.TrafficStats.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.gmailpostmastertools.v1beta1.PostmasterToolsRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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
  - List
```
protected List(String parent)
```
    List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain. Create a request for the method "trafficStats.list". This request holds the parameters needed by the the gmailpostmastertools server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    PostmasterTools.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    parent - The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListTrafficStatsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListTrafficStatsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public PostmasterTools.Domains.TrafficStats.List set$Xgafv(String $Xgafv)
```
    Description copied from class: PostmasterToolsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setAccessToken
```
public PostmasterTools.Domains.TrafficStats.List setAccessToken(String accessToken)
```
    Description copied from class: PostmasterToolsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setAlt
```
public PostmasterTools.Domains.TrafficStats.List setAlt(String alt)
```
    Description copied from class: PostmasterToolsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setCallback
```
public PostmasterTools.Domains.TrafficStats.List setCallback(String callback)
```
    Description copied from class: PostmasterToolsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setFields
```
public PostmasterTools.Domains.TrafficStats.List setFields(String fields)
```
    Description copied from class: PostmasterToolsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setKey
```
public PostmasterTools.Domains.TrafficStats.List setKey(String key)
```
    Description copied from class: PostmasterToolsRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setOauthToken
```
public PostmasterTools.Domains.TrafficStats.List setOauthToken(String oauthToken)
```
    Description copied from class: PostmasterToolsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setPrettyPrint
```
public PostmasterTools.Domains.TrafficStats.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: PostmasterToolsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setQuotaUser
```
public PostmasterTools.Domains.TrafficStats.List setQuotaUser(String quotaUser)
```
    Description copied from class: PostmasterToolsRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setUploadType
```
public PostmasterTools.Domains.TrafficStats.List setUploadType(String uploadType)
```
    Description copied from class: PostmasterToolsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - setUploadProtocol
```
public PostmasterTools.Domains.TrafficStats.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: PostmasterToolsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class PostmasterToolsRequest<ListTrafficStatsResponse>
  - getParent
```
public String getParent()
```
    The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.
  - setParent
```
public PostmasterTools.Domains.TrafficStats.List setParent(String parent)
```
    The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.
  - getEndDateDay
```
public Integer getEndDateDay()
```
    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
  - setEndDateDay
```
public PostmasterTools.Domains.TrafficStats.List setEndDateDay(Integer endDateDay)
```
    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
  - getEndDateMonth
```
public Integer getEndDateMonth()
```
    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  - setEndDateMonth
```
public PostmasterTools.Domains.TrafficStats.List setEndDateMonth(Integer endDateMonth)
```
    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  - getEndDateYear
```
public Integer getEndDateYear()
```
    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  - setEndDateYear
```
public PostmasterTools.Domains.TrafficStats.List setEndDateYear(Integer endDateYear)
```
    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  - getPageSize
```
public Integer getPageSize()
```
    Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.
  - setPageSize
```
public PostmasterTools.Domains.TrafficStats.List setPageSize(Integer pageSize)
```
    Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.
  - getPageToken
```
public String getPageToken()
```
    The next_page_token value returned from a previous List request, if any. This is the value of ListTrafficStatsResponse.next_page_token returned from the previous call to `ListTrafficStats` method.
  - setPageToken
```
public PostmasterTools.Domains.TrafficStats.List setPageToken(String pageToken)
```
    The next_page_token value returned from a previous List request, if any. This is the value of ListTrafficStatsResponse.next_page_token returned from the previous call to `ListTrafficStats` method.
  - getStartDateDay
```
public Integer getStartDateDay()
```
    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
  - setStartDateDay
```
public PostmasterTools.Domains.TrafficStats.List setStartDateDay(Integer startDateDay)
```
    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
  - getStartDateMonth
```
public Integer getStartDateMonth()
```
    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  - setStartDateMonth
```
public PostmasterTools.Domains.TrafficStats.List setStartDateMonth(Integer startDateMonth)
```
    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  - getStartDateYear
```
public Integer getStartDateYear()
```
    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  - setStartDateYear
```
public PostmasterTools.Domains.TrafficStats.List setStartDateYear(Integer startDateYear)
```
    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  - set
```
public PostmasterTools.Domains.TrafficStats.List set(String parameterName,
                                                     Object value)
```
    Overrides:
    
    set in class PostmasterToolsRequest<ListTrafficStatsResponse>

Class PostmasterTools.Domains.TrafficStats.List

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.gmailpostmastertools.v1beta1.PostmasterToolsRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

getEndDateDay

setEndDateDay

getEndDateMonth

setEndDateMonth

getEndDateYear

setEndDateYear

getPageSize

setPageSize

getPageToken

setPageToken

getStartDateDay

setStartDateDay

getStartDateMonth

setStartDateMonth

getStartDateYear

setStartDateYear

set