com.google.api.services.dfareporting.model

Class Report.Schedule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.Report.Schedule

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Report

public static final class Report.Schedule
extends GenericJson

The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

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>

Constructor Summary

Constructors

Constructor and Description
Schedule()

Method Summary

Modifier and Type	Method and Description
Report.Schedule	clone()
Boolean	getActive() Whether the schedule is active or not.
Integer	getEvery() Defines every how many days, weeks or months the report should be run.
DateTime	getExpirationDate()
String	getRepeats() The interval for which the report is repeated.
List<String>	getRepeatsOnWeekDays() List of week days "WEEKLY" on which scheduled reports should run.
String	getRunsOnDayOfMonth() Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month.
DateTime	getStartDate()
Report.Schedule	set(String fieldName, Object value)
Report.Schedule	setActive(Boolean active) Whether the schedule is active or not.
Report.Schedule	setEvery(Integer every) Defines every how many days, weeks or months the report should be run.
Report.Schedule	setExpirationDate(DateTime expirationDate)
Report.Schedule	setRepeats(String repeats) The interval for which the report is repeated.
Report.Schedule	setRepeatsOnWeekDays(List<String> repeatsOnWeekDays) List of week days "WEEKLY" on which scheduled reports should run.
Report.Schedule	setRunsOnDayOfMonth(String runsOnDayOfMonth) Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month.
Report.Schedule	setStartDate(DateTime startDate)

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

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

Schedule

public Schedule()

Method Detail

getActive

public Boolean getActive()

Whether the schedule is active or not. Must be set to either true or false.

Returns:

value or null for none

setActive

public Report.Schedule setActive(Boolean active)

Whether the schedule is active or not. Must be set to either true or false.

Parameters:

active - active or null for none

getEvery

public Integer getEvery()

Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".

Returns:

value or null for none

setEvery

public Report.Schedule setEvery(Integer every)

Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".

Parameters:

every - every or null for none

getExpirationDate

public DateTime getExpirationDate()

Returns:

value or null for none

setExpirationDate

public Report.Schedule setExpirationDate(DateTime expirationDate)

Parameters:

expirationDate - expirationDate or null for none

getRepeats

public String getRepeats()

The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.

Returns:

value or null for none

setRepeats

public Report.Schedule setRepeats(String repeats)

The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.

Parameters:

repeats - repeats or null for none

getRepeatsOnWeekDays

public List<String> getRepeatsOnWeekDays()

List of week days "WEEKLY" on which scheduled reports should run.

Returns:

value or null for none

setRepeatsOnWeekDays

public Report.Schedule setRepeatsOnWeekDays(List<String> repeatsOnWeekDays)

List of week days "WEEKLY" on which scheduled reports should run.

Parameters:

repeatsOnWeekDays - repeatsOnWeekDays or null for none

getRunsOnDayOfMonth

public String getRunsOnDayOfMonth()

Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.

Returns:

value or null for none

setRunsOnDayOfMonth

public Report.Schedule setRunsOnDayOfMonth(String runsOnDayOfMonth)

Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.

Parameters:

runsOnDayOfMonth - runsOnDayOfMonth or null for none

getStartDate

public DateTime getStartDate()

Returns:

value or null for none

setStartDate

public Report.Schedule setStartDate(DateTime startDate)

Parameters:

startDate - startDate or null for none

set

public Report.Schedule set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public Report.Schedule clone()

Overrides:

clone in class GenericJson