com.google.api.services.gkebackup.v1.model.Schedule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-gkebackup 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.gkebackup.v1.model;

/**
 * Defines scheduling parameters for automatically creating Backups via this BackupPlan.
 *
 *  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 Backup for GKE 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 Schedule extends com.google.api.client.json.GenericJson {

  /**
   * Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that defines a repeating
   * schedule for creating Backups via this BackupPlan. This is mutually exclusive with the
   * rpo_config field since at most one schedule can be defined for a BackupPlan. If this is
   * defined, then backup_retain_days must also be defined. Default (empty): no automatic backup
   * creation will occur.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String cronSchedule;

  /**
   * Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule
   * or rpo config.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String nextScheduledBackupTime;

  /**
   * Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan.
   * Default: False
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean paused;

  /**
   * Optional. Defines the RPO schedule configuration for this BackupPlan. This is mutually
   * exclusive with the cron_schedule field since at most one schedule can be defined for a
   * BackupPLan. If this is defined, then backup_retain_days must also be defined. Default (empty):
   * no automatic backup creation will occur.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private RpoConfig rpoConfig;

  /**
   * Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that defines a repeating
   * schedule for creating Backups via this BackupPlan. This is mutually exclusive with the
   * rpo_config field since at most one schedule can be defined for a BackupPlan. If this is
   * defined, then backup_retain_days must also be defined. Default (empty): no automatic backup
   * creation will occur.
   * @return value or {@code null} for none
   */
  public java.lang.String getCronSchedule() {
    return cronSchedule;
  }

  /**
   * Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that defines a repeating
   * schedule for creating Backups via this BackupPlan. This is mutually exclusive with the
   * rpo_config field since at most one schedule can be defined for a BackupPlan. If this is
   * defined, then backup_retain_days must also be defined. Default (empty): no automatic backup
   * creation will occur.
   * @param cronSchedule cronSchedule or {@code null} for none
   */
  public Schedule setCronSchedule(java.lang.String cronSchedule) {
    this.cronSchedule = cronSchedule;
    return this;
  }

  /**
   * Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule
   * or rpo config.
   * @return value or {@code null} for none
   */
  public String getNextScheduledBackupTime() {
    return nextScheduledBackupTime;
  }

  /**
   * Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule
   * or rpo config.
   * @param nextScheduledBackupTime nextScheduledBackupTime or {@code null} for none
   */
  public Schedule setNextScheduledBackupTime(String nextScheduledBackupTime) {
    this.nextScheduledBackupTime = nextScheduledBackupTime;
    return this;
  }

  /**
   * Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan.
   * Default: False
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getPaused() {
    return paused;
  }

  /**
   * Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan.
   * Default: False
   * @param paused paused or {@code null} for none
   */
  public Schedule setPaused(java.lang.Boolean paused) {
    this.paused = paused;
    return this;
  }

  /**
   * Optional. Defines the RPO schedule configuration for this BackupPlan. This is mutually
   * exclusive with the cron_schedule field since at most one schedule can be defined for a
   * BackupPLan. If this is defined, then backup_retain_days must also be defined. Default (empty):
   * no automatic backup creation will occur.
   * @return value or {@code null} for none
   */
  public RpoConfig getRpoConfig() {
    return rpoConfig;
  }

  /**
   * Optional. Defines the RPO schedule configuration for this BackupPlan. This is mutually
   * exclusive with the cron_schedule field since at most one schedule can be defined for a
   * BackupPLan. If this is defined, then backup_retain_days must also be defined. Default (empty):
   * no automatic backup creation will occur.
   * @param rpoConfig rpoConfig or {@code null} for none
   */
  public Schedule setRpoConfig(RpoConfig rpoConfig) {
    this.rpoConfig = rpoConfig;
    return this;
  }

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

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

}