File: DataSourceRefreshSchedule.java

package info (click to toggle)
google-api-services-sheets-java 1.32.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,008 kB
  • sloc: java: 12,826; xml: 161; makefile: 2
file content (189 lines) | stat: -rw-r--r-- 5,650 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.sheets.v4.model;

/**
 * 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
 * 8am , the refresh will take place between 8am and 12pm every day.
 *
 * <p> 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:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class DataSourceRefreshSchedule extends com.google.api.client.json.GenericJson {

  /**
   * Daily refresh schedule.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private DataSourceRefreshDailySchedule dailySchedule;

  /**
   * True if the refresh schedule is enabled, or false otherwise.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean enabled;

  /**
   * Monthly refresh schedule.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private DataSourceRefreshMonthlySchedule monthlySchedule;

  /**
   * Output only. The time interval of the next run.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Interval nextRun;

  /**
   * The scope of the refresh. Must be ALL_DATA_SOURCES.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String refreshScope;

  /**
   * Weekly refresh schedule.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private DataSourceRefreshWeeklySchedule weeklySchedule;

  /**
   * Daily refresh schedule.
   * @return value or {@code null} for none
   */
  public DataSourceRefreshDailySchedule getDailySchedule() {
    return dailySchedule;
  }

  /**
   * Daily refresh schedule.
   * @param dailySchedule dailySchedule or {@code null} for none
   */
  public DataSourceRefreshSchedule setDailySchedule(DataSourceRefreshDailySchedule dailySchedule) {
    this.dailySchedule = dailySchedule;
    return this;
  }

  /**
   * True if the refresh schedule is enabled, or false otherwise.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getEnabled() {
    return enabled;
  }

  /**
   * True if the refresh schedule is enabled, or false otherwise.
   * @param enabled enabled or {@code null} for none
   */
  public DataSourceRefreshSchedule setEnabled(java.lang.Boolean enabled) {
    this.enabled = enabled;
    return this;
  }

  /**
   * Monthly refresh schedule.
   * @return value or {@code null} for none
   */
  public DataSourceRefreshMonthlySchedule getMonthlySchedule() {
    return monthlySchedule;
  }

  /**
   * Monthly refresh schedule.
   * @param monthlySchedule monthlySchedule or {@code null} for none
   */
  public DataSourceRefreshSchedule setMonthlySchedule(DataSourceRefreshMonthlySchedule monthlySchedule) {
    this.monthlySchedule = monthlySchedule;
    return this;
  }

  /**
   * Output only. The time interval of the next run.
   * @return value or {@code null} for none
   */
  public Interval getNextRun() {
    return nextRun;
  }

  /**
   * Output only. The time interval of the next run.
   * @param nextRun nextRun or {@code null} for none
   */
  public DataSourceRefreshSchedule setNextRun(Interval nextRun) {
    this.nextRun = nextRun;
    return this;
  }

  /**
   * The scope of the refresh. Must be ALL_DATA_SOURCES.
   * @return value or {@code null} for none
   */
  public java.lang.String getRefreshScope() {
    return refreshScope;
  }

  /**
   * The scope of the refresh. Must be ALL_DATA_SOURCES.
   * @param refreshScope refreshScope or {@code null} for none
   */
  public DataSourceRefreshSchedule setRefreshScope(java.lang.String refreshScope) {
    this.refreshScope = refreshScope;
    return this;
  }

  /**
   * Weekly refresh schedule.
   * @return value or {@code null} for none
   */
  public DataSourceRefreshWeeklySchedule getWeeklySchedule() {
    return weeklySchedule;
  }

  /**
   * Weekly refresh schedule.
   * @param weeklySchedule weeklySchedule or {@code null} for none
   */
  public DataSourceRefreshSchedule setWeeklySchedule(DataSourceRefreshWeeklySchedule weeklySchedule) {
    this.weeklySchedule = weeklySchedule;
    return this;
  }

  @Override
  public DataSourceRefreshSchedule set(String fieldName, Object value) {
    return (DataSourceRefreshSchedule) super.set(fieldName, value);
  }

  @Override
  public DataSourceRefreshSchedule clone() {
    return (DataSourceRefreshSchedule) super.clone();
  }

}