com.google.api.services.appengine.model.ReadinessCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-appengine Show documentation
There is a newer version: v1-rev20241205-2.0.0
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * 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/google/apis-client-generator/
 * (build: 2017-11-07 19:12:12 UTC)
 * on 2017-12-15 at 01:51:25 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.appengine.model;

/**
 * Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic
 * 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 Google App Engine Admin 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 ReadinessCheck extends com.google.api.client.json.GenericJson {

  /**
   * A maximum time limit on application initialization, measured from moment the application
   * successfully replies to a healthcheck until it is ready to serve traffic.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String appStartTimeout;

  /**
   * Interval between health checks.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String checkInterval;

  /**
   * Number of consecutive failed checks required before removing traffic.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Long failureThreshold;

  /**
   * Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String host;

  /**
   * The request path.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String path;

  /**
   * Number of consecutive successful checks required before receiving traffic.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Long successThreshold;

  /**
   * Time before the check is considered failed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String timeout;

  /**
   * A maximum time limit on application initialization, measured from moment the application
   * successfully replies to a healthcheck until it is ready to serve traffic.
   * @return value or {@code null} for none
   */
  public String getAppStartTimeout() {
    return appStartTimeout;
  }

  /**
   * A maximum time limit on application initialization, measured from moment the application
   * successfully replies to a healthcheck until it is ready to serve traffic.
   * @param appStartTimeout appStartTimeout or {@code null} for none
   */
  public ReadinessCheck setAppStartTimeout(String appStartTimeout) {
    this.appStartTimeout = appStartTimeout;
    return this;
  }

  /**
   * Interval between health checks.
   * @return value or {@code null} for none
   */
  public String getCheckInterval() {
    return checkInterval;
  }

  /**
   * Interval between health checks.
   * @param checkInterval checkInterval or {@code null} for none
   */
  public ReadinessCheck setCheckInterval(String checkInterval) {
    this.checkInterval = checkInterval;
    return this;
  }

  /**
   * Number of consecutive failed checks required before removing traffic.
   * @return value or {@code null} for none
   */
  public java.lang.Long getFailureThreshold() {
    return failureThreshold;
  }

  /**
   * Number of consecutive failed checks required before removing traffic.
   * @param failureThreshold failureThreshold or {@code null} for none
   */
  public ReadinessCheck setFailureThreshold(java.lang.Long failureThreshold) {
    this.failureThreshold = failureThreshold;
    return this;
  }

  /**
   * Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
   * @return value or {@code null} for none
   */
  public java.lang.String getHost() {
    return host;
  }

  /**
   * Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
   * @param host host or {@code null} for none
   */
  public ReadinessCheck setHost(java.lang.String host) {
    this.host = host;
    return this;
  }

  /**
   * The request path.
   * @return value or {@code null} for none
   */
  public java.lang.String getPath() {
    return path;
  }

  /**
   * The request path.
   * @param path path or {@code null} for none
   */
  public ReadinessCheck setPath(java.lang.String path) {
    this.path = path;
    return this;
  }

  /**
   * Number of consecutive successful checks required before receiving traffic.
   * @return value or {@code null} for none
   */
  public java.lang.Long getSuccessThreshold() {
    return successThreshold;
  }

  /**
   * Number of consecutive successful checks required before receiving traffic.
   * @param successThreshold successThreshold or {@code null} for none
   */
  public ReadinessCheck setSuccessThreshold(java.lang.Long successThreshold) {
    this.successThreshold = successThreshold;
    return this;
  }

  /**
   * Time before the check is considered failed.
   * @return value or {@code null} for none
   */
  public String getTimeout() {
    return timeout;
  }

  /**
   * Time before the check is considered failed.
   * @param timeout timeout or {@code null} for none
   */
  public ReadinessCheck setTimeout(String timeout) {
    this.timeout = timeout;
    return this;
  }

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

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

}