com.google.api.services.secretmanager.v1.model.Rotation Maven / Gradle / Ivy

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

/**
 * The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a
 * Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to
 * configure rotation.
 *
 *  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 Secret Manager 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 Rotation extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less
   * than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be
   * set if rotation_period is set.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String nextRotationTime;

  /**
   * Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s
   * (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be
   * set. next_rotation_time will be advanced by this period when the service automatically sends
   * rotation notifications.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String rotationPeriod;

  /**
   * Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less
   * than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be
   * set if rotation_period is set.
   * @return value or {@code null} for none
   */
  public String getNextRotationTime() {
    return nextRotationTime;
  }

  /**
   * Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less
   * than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be
   * set if rotation_period is set.
   * @param nextRotationTime nextRotationTime or {@code null} for none
   */
  public Rotation setNextRotationTime(String nextRotationTime) {
    this.nextRotationTime = nextRotationTime;
    return this;
  }

  /**
   * Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s
   * (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be
   * set. next_rotation_time will be advanced by this period when the service automatically sends
   * rotation notifications.
   * @return value or {@code null} for none
   */
  public String getRotationPeriod() {
    return rotationPeriod;
  }

  /**
   * Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s
   * (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be
   * set. next_rotation_time will be advanced by this period when the service automatically sends
   * rotation notifications.
   * @param rotationPeriod rotationPeriod or {@code null} for none
   */
  public Rotation setRotationPeriod(String rotationPeriod) {
    this.rotationPeriod = rotationPeriod;
    return this;
  }

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

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

}