google_api_run v0.10.0 GoogleApi.Run.V1.Model.Probe View Source

Cloud Run fully managed: not supported

Cloud Run for Anthos: supported

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Attributes

  • exec (type: GoogleApi.Run.V1.Model.ExecAction.t, default: nil) - (Optional)

    Cloud Run fully managed: not supported

    Cloud Run for Anthos: supported

    One and only one of the following should be specified. Exec specifies the action to take.

    A field inlined from the Handler message.

  • failureThreshold (type: integer(), default: nil) - (Optional)

    Cloud Run fully managed: not supported

    Cloud Run for Anthos: supported

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

  • httpGet (type: GoogleApi.Run.V1.Model.HTTPGetAction.t, default: nil) - (Optional)

    Cloud Run fully managed: not supported

    Cloud Run for Anthos: supported

    HTTPGet specifies the http request to perform.

    A field inlined from the Handler message.

  • initialDelaySeconds (type: integer(), default: nil) - (Optional)

    Cloud Run fully managed: not supported

    Cloud Run for Anthos: supported

    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

  • periodSeconds (type: integer(), default: nil) - (Optional)

    Cloud Run fully managed: not supported

    Cloud Run for Anthos: supported

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

  • successThreshold (type: integer(), default: nil) - (Optional)

    Cloud Run fully managed: not supported

    Cloud Run for Anthos: supported

    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.

  • tcpSocket (type: GoogleApi.Run.V1.Model.TCPSocketAction.t, default: nil) - (Optional)

    Cloud Run fully managed: not supported

    Cloud Run for Anthos: supported

    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

    A field inlined from the Handler message.

  • timeoutSeconds (type: integer(), default: nil) - (Optional)

    Cloud Run fully managed: not supported

    Cloud Run for Anthos: supported

    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

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.Run.V1.Model.Probe{
  exec: GoogleApi.Run.V1.Model.ExecAction.t(),
  failureThreshold: integer(),
  httpGet: GoogleApi.Run.V1.Model.HTTPGetAction.t(),
  initialDelaySeconds: integer(),
  periodSeconds: integer(),
  successThreshold: integer(),
  tcpSocket: GoogleApi.Run.V1.Model.TCPSocketAction.t(),
  timeoutSeconds: integer()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.