Dfareporting.Files.Get (DCM/DFA Reporting And Trafficking API v3.0 (Rev. 1) 1.23.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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.dfareporting.DfareportingRequest<File>
        
        com.google.api.services.dfareporting.Dfareporting.Files.Get

All Implemented Interfaces:

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

Enclosing class:

Dfareporting.Files
```
public class Dfareporting.Files.Get
extends DfareportingRequest<File>
```

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>

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Dfareporting.Files.Get(java.lang.Long reportId, java.lang.Long fileId)` Retrieves a report file by its report ID and file ID.

Method Summary

Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeMedia()`
`void`	`executeMediaAndDownloadTo(java.io.OutputStream outputStream)`
`java.io.InputStream`	`executeMediaAsInputStream()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.Long`	`getFileId()` The ID of the report file.
`java.lang.Long`	`getReportId()` The ID of the report.
`Dfareporting.Files.Get`	`set(java.lang.String parameterName, java.lang.Object value)`
`Dfareporting.Files.Get`	`setAlt(java.lang.String alt)` Data format for the response.
`Dfareporting.Files.Get`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Dfareporting.Files.Get`	`setFileId(java.lang.Long fileId)` The ID of the report file.
`Dfareporting.Files.Get`	`setKey(java.lang.String key)` API key.
`Dfareporting.Files.Get`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Dfareporting.Files.Get`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dfareporting.Files.Get`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Dfareporting.Files.Get`	`setReportId(java.lang.Long reportId)` The ID of the report.
`Dfareporting.Files.Get`	`setUserIp(java.lang.String userIp)` IP address of the site where the request originates.

Methods inherited from class com.google.api.services.dfareporting.DfareportingRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Dfareporting.Files.Get
```
protected Dfareporting.Files.Get(java.lang.Long reportId,
                      java.lang.Long fileId)
```
    Retrieves a report file by its report ID and file ID. This method supports media download. Create a request for the method "files.get". This request holds the parameters needed by the the dfareporting server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Dfareporting.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    reportId - The ID of the report.
    fileId - The ID of the report file.
    Since:
    
    1.13
- Method Detail
  - executeMediaAndDownloadTo
```
public void executeMediaAndDownloadTo(java.io.OutputStream outputStream)
                               throws java.io.IOException
```
    Overrides:
    
    executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
    
    Throws:
    
    java.io.IOException
  - executeMediaAsInputStream
```
public java.io.InputStream executeMediaAsInputStream()
                                              throws java.io.IOException
```
    Overrides:
    
    executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
    
    Throws:
    
    java.io.IOException
  - executeMedia
```
public com.google.api.client.http.HttpResponse executeMedia()
                                                     throws java.io.IOException
```
    Overrides:
    
    executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
    
    Throws:
    
    java.io.IOException
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Dfareporting.Files.Get setAlt(java.lang.String alt)
```
    Description copied from class: DfareportingRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class DfareportingRequest<File>
  - setFields
```
public Dfareporting.Files.Get setFields(java.lang.String fields)
```
    Description copied from class: DfareportingRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DfareportingRequest<File>
  - setKey
```
public Dfareporting.Files.Get setKey(java.lang.String key)
```
    Description copied from class: DfareportingRequest
    
    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 DfareportingRequest<File>
  - setOauthToken
```
public Dfareporting.Files.Get setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DfareportingRequest<File>
  - setPrettyPrint
```
public Dfareporting.Files.Get setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: DfareportingRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DfareportingRequest<File>
  - setQuotaUser
```
public Dfareporting.Files.Get setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: DfareportingRequest
    
    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 userIp if both are provided.
    
    Overrides:
    
    setQuotaUser in class DfareportingRequest<File>
  - setUserIp
```
public Dfareporting.Files.Get setUserIp(java.lang.String userIp)
```
    Description copied from class: DfareportingRequest
    
    IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    
    Overrides:
    
    setUserIp in class DfareportingRequest<File>
  - getReportId
```
public java.lang.Long getReportId()
```
    The ID of the report.
  - setReportId
```
public Dfareporting.Files.Get setReportId(java.lang.Long reportId)
```
    The ID of the report.
  - getFileId
```
public java.lang.Long getFileId()
```
    The ID of the report file.
  - setFileId
```
public Dfareporting.Files.Get setFileId(java.lang.Long fileId)
```
    The ID of the report file.
  - set
```
public Dfareporting.Files.Get set(java.lang.String parameterName,
                         java.lang.Object value)
```
    Overrides:
    
    set in class DfareportingRequest<File>

DCM/DFA Reporting And Trafficking API v3.0 (revision 1)

Class Dfareporting.Files.Get

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.dfareporting.DfareportingRequest

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

Constructor Detail

Dfareporting.Files.Get

Method Detail

executeMediaAndDownloadTo

executeMediaAsInputStream

executeMedia

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getReportId

setReportId

getFileId

setFileId

set