com.google.api.services.dfareporting.model

Class File

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.File

All Implemented Interfaces:

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

public final class File
extends com.google.api.client.json.GenericJson

Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".

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 DCM/DFA Reporting And Trafficking 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

Modifier and Type	Class and Description
static class	File.Urls The URLs where the completed report file can be downloaded.

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>

Constructor Summary

Constructors

Constructor and Description
File()

Method Summary

Methods

Modifier and Type	Method and Description
File	clone()
DateRange	getDateRange() The date range for which the file has report data.
java.lang.String	getEtag() The eTag of this response for caching purposes.
java.lang.String	getFileName() The filename of the file.
java.lang.String	getFormat() The output format of the report.
java.lang.Long	getId() The unique ID of this report file.
java.lang.String	getKind() The kind of resource this is, in this case dfareporting#file.
java.lang.Long	getLastModifiedTime() The timestamp in milliseconds since epoch when this file was last modified.
java.lang.Long	getReportId() The ID of the report this file was generated from.
java.lang.String	getStatus() The status of the report file.
File.Urls	getUrls() The URLs where the completed report file can be downloaded.
File	set(java.lang.String fieldName, java.lang.Object value)
File	setDateRange(DateRange dateRange) The date range for which the file has report data.
File	setEtag(java.lang.String etag) The eTag of this response for caching purposes.
File	setFileName(java.lang.String fileName) The filename of the file.
File	setFormat(java.lang.String format) The output format of the report.
File	setId(java.lang.Long id) The unique ID of this report file.
File	setKind(java.lang.String kind) The kind of resource this is, in this case dfareporting#file.
File	setLastModifiedTime(java.lang.Long lastModifiedTime) The timestamp in milliseconds since epoch when this file was last modified.
File	setReportId(java.lang.Long reportId) The ID of the report this file was generated from.
File	setStatus(java.lang.String status) The status of the report file.
File	setUrls(File.Urls urls) The URLs where the completed report file can be downloaded.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

File

public File()

Method Detail

getDateRange

public DateRange getDateRange()

The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.

Returns:

value or null for none

setDateRange

public File setDateRange(DateRange dateRange)

The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.

Parameters:

dateRange - dateRange or null for none

getEtag

public java.lang.String getEtag()

The eTag of this response for caching purposes.

Returns:

value or null for none

setEtag

public File setEtag(java.lang.String etag)

The eTag of this response for caching purposes.

Parameters:

etag - etag or null for none

getFileName

public java.lang.String getFileName()

The filename of the file.

Returns:

value or null for none

setFileName

public File setFileName(java.lang.String fileName)

The filename of the file.

Parameters:

fileName - fileName or null for none

getFormat

public java.lang.String getFormat()

The output format of the report. Only available once the file is available.

Returns:

value or null for none

setFormat

public File setFormat(java.lang.String format)

The output format of the report. Only available once the file is available.

Parameters:

format - format or null for none

getId

public java.lang.Long getId()

The unique ID of this report file.

Returns:

value or null for none

setId

public File setId(java.lang.Long id)

The unique ID of this report file.

Parameters:

id - id or null for none

getKind

public java.lang.String getKind()

The kind of resource this is, in this case dfareporting#file.

Returns:

value or null for none

setKind

public File setKind(java.lang.String kind)

The kind of resource this is, in this case dfareporting#file.

Parameters:

kind - kind or null for none

getLastModifiedTime

public java.lang.Long getLastModifiedTime()

The timestamp in milliseconds since epoch when this file was last modified.

Returns:

value or null for none

setLastModifiedTime

public File setLastModifiedTime(java.lang.Long lastModifiedTime)

The timestamp in milliseconds since epoch when this file was last modified.

Parameters:

lastModifiedTime - lastModifiedTime or null for none

getReportId

public java.lang.Long getReportId()

The ID of the report this file was generated from.

Returns:

value or null for none

setReportId

public File setReportId(java.lang.Long reportId)

The ID of the report this file was generated from.

Parameters:

reportId - reportId or null for none

getStatus

public java.lang.String getStatus()

The status of the report file.

Returns:

value or null for none

setStatus

public File setStatus(java.lang.String status)

The status of the report file.

Parameters:

status - status or null for none

getUrls

public File.Urls getUrls()

The URLs where the completed report file can be downloaded.

Returns:

value or null for none

setUrls

public File setUrls(File.Urls urls)

The URLs where the completed report file can be downloaded.

Parameters:

urls - urls or null for none

set

public File set(java.lang.String fieldName,
       java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public File clone()

Overrides:

clone in class com.google.api.client.json.GenericJson