com.google.api.services.gmailpostmastertools.v1beta1

Class PostmasterTools.Domains.TrafficStats.Get

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

com.google.api.services.gmailpostmastertools.v1beta1.PostmasterTools.Domains.TrafficStats.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

PostmasterTools.Domains.TrafficStats

public class PostmasterTools.Domains.TrafficStats.Get
extends PostmasterToolsRequest<TrafficStats>

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	Get(String name) Get traffic statistics for a domain on a specific date.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getName() The resource name of the traffic statistics to get.
PostmasterTools.Domains.TrafficStats.Get	set(String parameterName, Object value)
PostmasterTools.Domains.TrafficStats.Get	set$Xgafv(String $Xgafv) V1 error format.
PostmasterTools.Domains.TrafficStats.Get	setAccessToken(String accessToken) OAuth access token.
PostmasterTools.Domains.TrafficStats.Get	setAlt(String alt) Data format for response.
PostmasterTools.Domains.TrafficStats.Get	setCallback(String callback) JSONP
PostmasterTools.Domains.TrafficStats.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
PostmasterTools.Domains.TrafficStats.Get	setKey(String key) API key.
PostmasterTools.Domains.TrafficStats.Get	setName(String name) The resource name of the traffic statistics to get.
PostmasterTools.Domains.TrafficStats.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
PostmasterTools.Domains.TrafficStats.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
PostmasterTools.Domains.TrafficStats.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
PostmasterTools.Domains.TrafficStats.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
PostmasterTools.Domains.TrafficStats.Get	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

Get

protected Get(String name)

Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain. Create a request for the method "trafficStats.get". 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:

name - The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807.

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

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<TrafficStats>

Throws:

IOException

set$Xgafv

public PostmasterTools.Domains.TrafficStats.Get set$Xgafv(String $Xgafv)

Description copied from class: PostmasterToolsRequest

V1 error format.

Overrides:

set$Xgafv in class PostmasterToolsRequest<TrafficStats>

setAccessToken

public PostmasterTools.Domains.TrafficStats.Get setAccessToken(String accessToken)

Description copied from class: PostmasterToolsRequest

OAuth access token.

Overrides:

setAccessToken in class PostmasterToolsRequest<TrafficStats>

setAlt

public PostmasterTools.Domains.TrafficStats.Get setAlt(String alt)

Description copied from class: PostmasterToolsRequest

Data format for response.

Overrides:

setAlt in class PostmasterToolsRequest<TrafficStats>

setCallback

public PostmasterTools.Domains.TrafficStats.Get setCallback(String callback)

Description copied from class: PostmasterToolsRequest

JSONP

Overrides:

setCallback in class PostmasterToolsRequest<TrafficStats>

setFields

public PostmasterTools.Domains.TrafficStats.Get setFields(String fields)

Description copied from class: PostmasterToolsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PostmasterToolsRequest<TrafficStats>

setKey

public PostmasterTools.Domains.TrafficStats.Get 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<TrafficStats>

setOauthToken

public PostmasterTools.Domains.TrafficStats.Get setOauthToken(String oauthToken)

Description copied from class: PostmasterToolsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PostmasterToolsRequest<TrafficStats>

setPrettyPrint

public PostmasterTools.Domains.TrafficStats.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: PostmasterToolsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PostmasterToolsRequest<TrafficStats>

setQuotaUser

public PostmasterTools.Domains.TrafficStats.Get 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<TrafficStats>

setUploadType

public PostmasterTools.Domains.TrafficStats.Get setUploadType(String uploadType)

Description copied from class: PostmasterToolsRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class PostmasterToolsRequest<TrafficStats>

setUploadProtocol

public PostmasterTools.Domains.TrafficStats.Get setUploadProtocol(String uploadProtocol)

Description copied from class: PostmasterToolsRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class PostmasterToolsRequest<TrafficStats>

getName

public String getName()

The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807.

setName

public PostmasterTools.Domains.TrafficStats.Get setName(String name)

The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807.

set

public PostmasterTools.Domains.TrafficStats.Get set(String parameterName,
                                                    Object value)

Overrides:

set in class PostmasterToolsRequest<TrafficStats>