target.apidocs.com.google.api.services.sheets.v4.model.DataSourceRefreshSchedule.html Maven / Gradle / Ivy
DataSourceRefreshSchedule (Google Sheets API v4-rev20240319-2.0.0)
com.google.api.services.sheets.v4.model
Class DataSourceRefreshSchedule
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.sheets.v4.model.DataSourceRefreshSchedule
-
public final class DataSourceRefreshSchedule
extends com.google.api.client.json.GenericJson
Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a
time interval. You can specify the start time by clicking the Scheduled Refresh button in the
Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of
8 AM , the refresh will take place between 8 AM and 12 PM every day.
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 Google Sheets 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>
-
Constructor Summary
Constructors
Constructor and Description
DataSourceRefreshSchedule()
-
Method Summary
-
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
-
-
Method Detail
-
getDailySchedule
public DataSourceRefreshDailySchedule getDailySchedule()
Daily refresh schedule.
- Returns:
- value or
null for none
-
setDailySchedule
public DataSourceRefreshSchedule setDailySchedule(DataSourceRefreshDailySchedule dailySchedule)
Daily refresh schedule.
- Parameters:
dailySchedule - dailySchedule or null for none
-
getEnabled
public Boolean getEnabled()
True if the refresh schedule is enabled, or false otherwise.
- Returns:
- value or
null for none
-
setEnabled
public DataSourceRefreshSchedule setEnabled(Boolean enabled)
True if the refresh schedule is enabled, or false otherwise.
- Parameters:
enabled - enabled or null for none
-
getMonthlySchedule
public DataSourceRefreshMonthlySchedule getMonthlySchedule()
Monthly refresh schedule.
- Returns:
- value or
null for none
-
setMonthlySchedule
public DataSourceRefreshSchedule setMonthlySchedule(DataSourceRefreshMonthlySchedule monthlySchedule)
Monthly refresh schedule.
- Parameters:
monthlySchedule - monthlySchedule or null for none
-
getNextRun
public Interval getNextRun()
Output only. The time interval of the next run.
- Returns:
- value or
null for none
-
setNextRun
public DataSourceRefreshSchedule setNextRun(Interval nextRun)
Output only. The time interval of the next run.
- Parameters:
nextRun - nextRun or null for none
-
getRefreshScope
public String getRefreshScope()
The scope of the refresh. Must be ALL_DATA_SOURCES.
- Returns:
- value or
null for none
-
setRefreshScope
public DataSourceRefreshSchedule setRefreshScope(String refreshScope)
The scope of the refresh. Must be ALL_DATA_SOURCES.
- Parameters:
refreshScope - refreshScope or null for none
-
getWeeklySchedule
public DataSourceRefreshWeeklySchedule getWeeklySchedule()
Weekly refresh schedule.
- Returns:
- value or
null for none
-
setWeeklySchedule
public DataSourceRefreshSchedule setWeeklySchedule(DataSourceRefreshWeeklySchedule weeklySchedule)
Weekly refresh schedule.
- Parameters:
weeklySchedule - weeklySchedule or null for none
-
set
public DataSourceRefreshSchedule set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public DataSourceRefreshSchedule clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.