com.google.api.services.doubleclickbidmanager.model

Class QuerySchedule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.doubleclickbidmanager.model.QuerySchedule

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Settings on when and how frequently to run a query.

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 DoubleClick Bid Manager 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/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>

Constructor Summary

Constructors

Constructor and Description
QuerySchedule()

Method Summary

Modifier and Type	Method and Description
QuerySchedule	clone()
Date	getEndDate() The date on which to end the scheduled runs.
String	getFrequency() How frequently to run the query.
String	getNextRunTimezoneCode() The canonical code for the timezone the query schedule is based on.
Date	getStartDate() The date on which to begin the scheduled runs.
QuerySchedule	set(String fieldName, Object value)
QuerySchedule	setEndDate(Date endDate) The date on which to end the scheduled runs.
QuerySchedule	setFrequency(String frequency) How frequently to run the query.
QuerySchedule	setNextRunTimezoneCode(String nextRunTimezoneCode) The canonical code for the timezone the query schedule is based on.
QuerySchedule	setStartDate(Date startDate) The date on which to begin the scheduled runs.

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

QuerySchedule

public QuerySchedule()

Method Detail

getEndDate

public Date getEndDate()

The date on which to end the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored.

Returns:

value or null for none

setEndDate

public QuerySchedule setEndDate(Date endDate)

The date on which to end the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored.

Parameters:

endDate - endDate or null for none

getFrequency

public String getFrequency()

How frequently to run the query. If set to `ONE_TIME`, the query will only be run when queries.run is called.

Returns:

value or null for none

setFrequency

public QuerySchedule setFrequency(String frequency)

How frequently to run the query. If set to `ONE_TIME`, the query will only be run when queries.run is called.

Parameters:

frequency - frequency or null for none

getNextRunTimezoneCode

public String getNextRunTimezoneCode()

The canonical code for the timezone the query schedule is based on. Scheduled runs are usually conducted in the morning of a given day. Defaults to `America/New_York`.

Returns:

value or null for none

setNextRunTimezoneCode

public QuerySchedule setNextRunTimezoneCode(String nextRunTimezoneCode)

The canonical code for the timezone the query schedule is based on. Scheduled runs are usually conducted in the morning of a given day. Defaults to `America/New_York`.

Parameters:

nextRunTimezoneCode - nextRunTimezoneCode or null for none

getStartDate

public Date getStartDate()

The date on which to begin the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored.

Returns:

value or null for none

setStartDate

public QuerySchedule setStartDate(Date startDate)

The date on which to begin the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored.

Parameters:

startDate - startDate or null for none

set

public QuerySchedule set(String fieldName,
                         Object value)

Overrides:

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

clone

public QuerySchedule clone()

Overrides:

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