com.google.api.services.sheets.v4.model.DataSourceRefreshMonthlySchedule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-sheets Show documentation
The newest version!
/*
 * 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;

/**
 * A monthly schedule for data to refresh on specific days in the month in a given time interval.
 *
 *  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.
 */
@SuppressWarnings("javadoc")
public final class DataSourceRefreshMonthlySchedule extends com.google.api.client.json.GenericJson {

  /**
   * Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At
   * least one day must be specified.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List daysOfMonth;

  /**
   * The start time of a time interval in which a data source refresh is scheduled. Only `hours`
   * part is used. The time interval size defaults to that in the Sheets editor.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TimeOfDay startTime;

  /**
   * Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At
   * least one day must be specified.
   * @return value or {@code null} for none
   */
  public java.util.List getDaysOfMonth() {
    return daysOfMonth;
  }

  /**
   * Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At
   * least one day must be specified.
   * @param daysOfMonth daysOfMonth or {@code null} for none
   */
  public DataSourceRefreshMonthlySchedule setDaysOfMonth(java.util.List daysOfMonth) {
    this.daysOfMonth = daysOfMonth;
    return this;
  }

  /**
   * The start time of a time interval in which a data source refresh is scheduled. Only `hours`
   * part is used. The time interval size defaults to that in the Sheets editor.
   * @return value or {@code null} for none
   */
  public TimeOfDay getStartTime() {
    return startTime;
  }

  /**
   * The start time of a time interval in which a data source refresh is scheduled. Only `hours`
   * part is used. The time interval size defaults to that in the Sheets editor.
   * @param startTime startTime or {@code null} for none
   */
  public DataSourceRefreshMonthlySchedule setStartTime(TimeOfDay startTime) {
    this.startTime = startTime;
    return this;
  }

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

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

}