com.google.api.services.doubleclicksearch

Class Doubleclicksearch.Reports.GetFile

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.doubleclicksearch.DoubleclicksearchRequest<Void>

com.google.api.services.doubleclicksearch.Doubleclicksearch.Reports.GetFile

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Doubleclicksearch.Reports

public class Doubleclicksearch.Reports.GetFile
extends DoubleclicksearchRequest<Void>

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetFile(String reportId, Integer reportFragment) Downloads a report file encoded in UTF-8.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.GenericUrl	buildHttpRequestUrl()
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(OutputStream outputStream)
InputStream	executeMediaAsInputStream()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getReportFragment() The index of the report fragment to download.
String	getReportId() ID of the report.
Doubleclicksearch.Reports.GetFile	set(String parameterName, Object value)
Doubleclicksearch.Reports.GetFile	set$Xgafv(String $Xgafv) V1 error format.
Doubleclicksearch.Reports.GetFile	setAccessToken(String accessToken) OAuth access token.
Doubleclicksearch.Reports.GetFile	setAlt(String alt) Data format for response.
Doubleclicksearch.Reports.GetFile	setCallback(String callback) JSONP
Doubleclicksearch.Reports.GetFile	setFields(String fields) Selector specifying which fields to include in a partial response.
Doubleclicksearch.Reports.GetFile	setKey(String key) API key.
Doubleclicksearch.Reports.GetFile	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Doubleclicksearch.Reports.GetFile	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Doubleclicksearch.Reports.GetFile	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Doubleclicksearch.Reports.GetFile	setReportFragment(Integer reportFragment) The index of the report fragment to download.
Doubleclicksearch.Reports.GetFile	setReportId(String reportId) ID of the report.
Doubleclicksearch.Reports.GetFile	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Doubleclicksearch.Reports.GetFile	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.doubleclicksearch.DoubleclicksearchRequest

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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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

GetFile

protected GetFile(String reportId,
                  Integer reportFragment)

Downloads a report file encoded in UTF-8. Create a request for the method "reports.getFile". This request holds the parameters needed by the the doubleclicksearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Doubleclicksearch.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

reportId - ID of the report.

reportFragment - The index of the report fragment to download. [minimum: 0]

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:

executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>

Throws:

IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:

executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>

Throws:

IOException

executeMedia

public com.google.api.client.http.HttpResponse executeMedia()
                                                     throws IOException

Overrides:

executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>

Throws:

IOException

buildHttpRequestUrl

public com.google.api.client.http.GenericUrl buildHttpRequestUrl()

Overrides:

buildHttpRequestUrl in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Void>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Doubleclicksearch.Reports.GetFile set$Xgafv(String $Xgafv)

Description copied from class: DoubleclicksearchRequest

V1 error format.

Overrides:

set$Xgafv in class DoubleclicksearchRequest<Void>

setAccessToken

public Doubleclicksearch.Reports.GetFile setAccessToken(String accessToken)

Description copied from class: DoubleclicksearchRequest

OAuth access token.

Overrides:

setAccessToken in class DoubleclicksearchRequest<Void>

setAlt

public Doubleclicksearch.Reports.GetFile setAlt(String alt)

Description copied from class: DoubleclicksearchRequest

Data format for response.

Overrides:

setAlt in class DoubleclicksearchRequest<Void>

setCallback

public Doubleclicksearch.Reports.GetFile setCallback(String callback)

Description copied from class: DoubleclicksearchRequest

JSONP

Overrides:

setCallback in class DoubleclicksearchRequest<Void>

setFields

public Doubleclicksearch.Reports.GetFile setFields(String fields)

Description copied from class: DoubleclicksearchRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DoubleclicksearchRequest<Void>

setKey

public Doubleclicksearch.Reports.GetFile setKey(String key)

Description copied from class: DoubleclicksearchRequest

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 DoubleclicksearchRequest<Void>

setOauthToken

public Doubleclicksearch.Reports.GetFile setOauthToken(String oauthToken)

Description copied from class: DoubleclicksearchRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DoubleclicksearchRequest<Void>

setPrettyPrint

public Doubleclicksearch.Reports.GetFile setPrettyPrint(Boolean prettyPrint)

Description copied from class: DoubleclicksearchRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DoubleclicksearchRequest<Void>

setQuotaUser

public Doubleclicksearch.Reports.GetFile setQuotaUser(String quotaUser)

Description copied from class: DoubleclicksearchRequest

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 DoubleclicksearchRequest<Void>

setUploadType

public Doubleclicksearch.Reports.GetFile setUploadType(String uploadType)

Description copied from class: DoubleclicksearchRequest

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

Overrides:

setUploadType in class DoubleclicksearchRequest<Void>

setUploadProtocol

public Doubleclicksearch.Reports.GetFile setUploadProtocol(String uploadProtocol)

Description copied from class: DoubleclicksearchRequest

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

Overrides:

setUploadProtocol in class DoubleclicksearchRequest<Void>

getReportId

public String getReportId()

ID of the report.

setReportId

public Doubleclicksearch.Reports.GetFile setReportId(String reportId)

ID of the report.

getReportFragment

public Integer getReportFragment()

The index of the report fragment to download. [minimum: 0]

setReportFragment

public Doubleclicksearch.Reports.GetFile setReportFragment(Integer reportFragment)

The index of the report fragment to download.

set

public Doubleclicksearch.Reports.GetFile set(String parameterName,
                                             Object value)

Overrides:

set in class DoubleclicksearchRequest<Void>