com.google.api.services.run.v1alpha1.model.Probe Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-run Show documentation
There is a newer version: v2-rev20241213-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://code.google.com/p/google-apis-client-generator/
 * (build: 2018-10-08 17:45:39 UTC)
 * on 2019-11-08 at 00:46:02 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.run.v1alpha1.model;

/**
 * Probe describes a health check to be performed against a container to determine whether it is
 * alive or ready to receive traffic.
 *
 *  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 Cloud Run API. For a detailed explanation see:
 * http://code.google.com/p/google-http-java-client/wiki/JSON
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class Probe extends com.google.api.client.json.GenericJson {

  /**
   * Minimum consecutive failures for the probe to be considered failed after having succeeded.
   * Defaults to 3. Minimum value is 1. +optional
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer failureThreshold;

  /**
   * The action taken to determine the health of a container
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Handler handler;

  /**
   * Number of seconds after the container has started before liveness probes are initiated. More
   * info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
   * +optional
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer initialDelaySeconds;

  /**
   * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
   * +optional
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer periodSeconds;

  /**
   * Minimum consecutive successes for the probe to be considered successful after having failed.
   * Defaults to 1. Must be 1 for liveness. Minimum value is 1. +optional
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer successThreshold;

  /**
   * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
   * More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
   * +optional
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer timeoutSeconds;

  /**
   * Minimum consecutive failures for the probe to be considered failed after having succeeded.
   * Defaults to 3. Minimum value is 1. +optional
   * @return value or {@code null} for none
   */
  public java.lang.Integer getFailureThreshold() {
    return failureThreshold;
  }

  /**
   * Minimum consecutive failures for the probe to be considered failed after having succeeded.
   * Defaults to 3. Minimum value is 1. +optional
   * @param failureThreshold failureThreshold or {@code null} for none
   */
  public Probe setFailureThreshold(java.lang.Integer failureThreshold) {
    this.failureThreshold = failureThreshold;
    return this;
  }

  /**
   * The action taken to determine the health of a container
   * @return value or {@code null} for none
   */
  public Handler getHandler() {
    return handler;
  }

  /**
   * The action taken to determine the health of a container
   * @param handler handler or {@code null} for none
   */
  public Probe setHandler(Handler handler) {
    this.handler = handler;
    return this;
  }

  /**
   * Number of seconds after the container has started before liveness probes are initiated. More
   * info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
   * +optional
   * @return value or {@code null} for none
   */
  public java.lang.Integer getInitialDelaySeconds() {
    return initialDelaySeconds;
  }

  /**
   * Number of seconds after the container has started before liveness probes are initiated. More
   * info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
   * +optional
   * @param initialDelaySeconds initialDelaySeconds or {@code null} for none
   */
  public Probe setInitialDelaySeconds(java.lang.Integer initialDelaySeconds) {
    this.initialDelaySeconds = initialDelaySeconds;
    return this;
  }

  /**
   * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
   * +optional
   * @return value or {@code null} for none
   */
  public java.lang.Integer getPeriodSeconds() {
    return periodSeconds;
  }

  /**
   * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
   * +optional
   * @param periodSeconds periodSeconds or {@code null} for none
   */
  public Probe setPeriodSeconds(java.lang.Integer periodSeconds) {
    this.periodSeconds = periodSeconds;
    return this;
  }

  /**
   * Minimum consecutive successes for the probe to be considered successful after having failed.
   * Defaults to 1. Must be 1 for liveness. Minimum value is 1. +optional
   * @return value or {@code null} for none
   */
  public java.lang.Integer getSuccessThreshold() {
    return successThreshold;
  }

  /**
   * Minimum consecutive successes for the probe to be considered successful after having failed.
   * Defaults to 1. Must be 1 for liveness. Minimum value is 1. +optional
   * @param successThreshold successThreshold or {@code null} for none
   */
  public Probe setSuccessThreshold(java.lang.Integer successThreshold) {
    this.successThreshold = successThreshold;
    return this;
  }

  /**
   * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
   * More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
   * +optional
   * @return value or {@code null} for none
   */
  public java.lang.Integer getTimeoutSeconds() {
    return timeoutSeconds;
  }

  /**
   * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.
   * More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
   * +optional
   * @param timeoutSeconds timeoutSeconds or {@code null} for none
   */
  public Probe setTimeoutSeconds(java.lang.Integer timeoutSeconds) {
    this.timeoutSeconds = timeoutSeconds;
    return this;
  }

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

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

}