Package com.azure.resourcemanager.appcontainers.models

Class ContainerAppProbe

java.lang.Object
com.azure.resourcemanager.appcontainers.models.ContainerAppProbe
public final class ContainerAppProbe extends Object
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

  • Constructor Details

    • ContainerAppProbe

      public ContainerAppProbe()
      Creates an instance of ContainerAppProbe class.

  • Method Details

    • failureThreshold

      public Integer failureThreshold()
      Get the failureThreshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.
      Returns:
      the failureThreshold value.

    • withFailureThreshold

      public ContainerAppProbe withFailureThreshold(Integer failureThreshold)
      Set the failureThreshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.
      Parameters:
      failureThreshold - the failureThreshold value to set.
      Returns:
      the ContainerAppProbe object itself.

    • httpGet

      public ContainerAppProbeHttpGet httpGet()
      Get the httpGet property: HTTPGet specifies the http request to perform.
      Returns:
      the httpGet value.

    • withHttpGet

      public ContainerAppProbe withHttpGet(ContainerAppProbeHttpGet httpGet)
      Set the httpGet property: HTTPGet specifies the http request to perform.
      Parameters:
      httpGet - the httpGet value to set.
      Returns:
      the ContainerAppProbe object itself.

    • initialDelaySeconds

      public Integer initialDelaySeconds()
      Get the initialDelaySeconds property: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.
      Returns:
      the initialDelaySeconds value.

    • withInitialDelaySeconds

      public ContainerAppProbe withInitialDelaySeconds(Integer initialDelaySeconds)
      Set the initialDelaySeconds property: Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.
      Parameters:
      initialDelaySeconds - the initialDelaySeconds value to set.
      Returns:
      the ContainerAppProbe object itself.

    • periodSeconds

      public Integer periodSeconds()
      Get the periodSeconds property: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
      Returns:
      the periodSeconds value.

    • withPeriodSeconds

      public ContainerAppProbe withPeriodSeconds(Integer periodSeconds)
      Set the periodSeconds property: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
      Parameters:
      periodSeconds - the periodSeconds value to set.
      Returns:
      the ContainerAppProbe object itself.

    • successThreshold

      public Integer successThreshold()
      Get the successThreshold property: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.
      Returns:
      the successThreshold value.

    • withSuccessThreshold

      public ContainerAppProbe withSuccessThreshold(Integer successThreshold)
      Set the successThreshold property: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.
      Parameters:
      successThreshold - the successThreshold value to set.
      Returns:
      the ContainerAppProbe object itself.

    • tcpSocket

      public ContainerAppProbeTcpSocket tcpSocket()
      Get the tcpSocket property: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
      Returns:
      the tcpSocket value.

    • withTcpSocket

      public ContainerAppProbe withTcpSocket(ContainerAppProbeTcpSocket tcpSocket)
      Set the tcpSocket property: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
      Parameters:
      tcpSocket - the tcpSocket value to set.
      Returns:
      the ContainerAppProbe object itself.

    • terminationGracePeriodSeconds

      public Long terminationGracePeriodSeconds()
      Get the terminationGracePeriodSeconds property: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour).
      Returns:
      the terminationGracePeriodSeconds value.

    • withTerminationGracePeriodSeconds

      public ContainerAppProbe withTerminationGracePeriodSeconds(Long terminationGracePeriodSeconds)
      Set the terminationGracePeriodSeconds property: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour).
      Parameters:
      terminationGracePeriodSeconds - the terminationGracePeriodSeconds value to set.
      Returns:
      the ContainerAppProbe object itself.

    • timeoutSeconds

      public Integer timeoutSeconds()
      Get the timeoutSeconds property: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.
      Returns:
      the timeoutSeconds value.

    • withTimeoutSeconds

      public ContainerAppProbe withTimeoutSeconds(Integer timeoutSeconds)
      Set the timeoutSeconds property: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.
      Parameters:
      timeoutSeconds - the timeoutSeconds value to set.
      Returns:
      the ContainerAppProbe object itself.

    • type

      public Type type()
      Get the type property: The type of probe.
      Returns:
      the type value.

    • withType

      public ContainerAppProbe withType(Type type)
      Set the type property: The type of probe.
      Parameters:
      type - the type value to set.
      Returns:
      the ContainerAppProbe object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.