Reference documentation and code samples for the Google Cloud Run V2 Client class Probe.
Probe describes a health check to be performed against a container to
determine whether it is alive or ready to receive traffic.
Generated from protobuf messagegoogle.cloud.run.v2.Probe
Namespace
Google \ Cloud \ Run \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ initial_delay_seconds
int
Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
↳ timeout_seconds
int
Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
↳ period_seconds
int
Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
↳ failure_threshold
int
Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
getInitialDelaySeconds
Optional. Number of seconds after the container has started before the
probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum
value for liveness probe is 3600. Maximum value for startup probe is 240.
Returns
Type
Description
int
setInitialDelaySeconds
Optional. Number of seconds after the container has started before the
probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum
value for liveness probe is 3600. Maximum value for startup probe is 240.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getTimeoutSeconds
Optional. Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1. Maximum value is 3600.
Must be smaller than period_seconds.
Returns
Type
Description
int
setTimeoutSeconds
Optional. Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1. Maximum value is 3600.
Must be smaller than period_seconds.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPeriodSeconds
Optional. How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe
is 3600. Maximum value for startup probe is 240.
Must be greater or equal than timeout_seconds.
Returns
Type
Description
int
setPeriodSeconds
Optional. How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe
is 3600. Maximum value for startup probe is 240.
Must be greater or equal than timeout_seconds.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getFailureThreshold
Optional. Minimum consecutive failures for the probe to be considered
failed after having succeeded. Defaults to 3. Minimum value is 1.
Returns
Type
Description
int
setFailureThreshold
Optional. Minimum consecutive failures for the probe to be considered
failed after having succeeded. Defaults to 3. Minimum value is 1.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getHttpGet
Optional. HTTPGet specifies the http request to perform.
Exactly one of httpGet, tcpSocket, or grpc must be specified.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Run V2 Client - Class Probe (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/php/docs/reference/cloud-run/latest/V2.Probe)\n- [1.8.0](/php/docs/reference/cloud-run/1.8.0/V2.Probe)\n- [1.7.0](/php/docs/reference/cloud-run/1.7.0/V2.Probe)\n- [1.6.0](/php/docs/reference/cloud-run/1.6.0/V2.Probe)\n- [1.5.2](/php/docs/reference/cloud-run/1.5.2/V2.Probe)\n- [1.4.0](/php/docs/reference/cloud-run/1.4.0/V2.Probe)\n- [1.3.0](/php/docs/reference/cloud-run/1.3.0/V2.Probe)\n- [1.2.0](/php/docs/reference/cloud-run/1.2.0/V2.Probe)\n- [1.1.0](/php/docs/reference/cloud-run/1.1.0/V2.Probe)\n- [1.0.0](/php/docs/reference/cloud-run/1.0.0/V2.Probe)\n- [0.9.3](/php/docs/reference/cloud-run/0.9.3/V2.Probe)\n- [0.8.0](/php/docs/reference/cloud-run/0.8.0/V2.Probe)\n- [0.7.2](/php/docs/reference/cloud-run/0.7.2/V2.Probe)\n- [0.6.0](/php/docs/reference/cloud-run/0.6.0/V2.Probe)\n- [0.5.2](/php/docs/reference/cloud-run/0.5.2/V2.Probe)\n- [0.4.0](/php/docs/reference/cloud-run/0.4.0/V2.Probe)\n- [0.3.4](/php/docs/reference/cloud-run/0.3.4/V2.Probe) \nReference documentation and code samples for the Google Cloud Run V2 Client class Probe.\n\nProbe describes a health check to be performed against a container to\ndetermine whether it is alive or ready to receive traffic.\n\nGenerated from protobuf message `google.cloud.run.v2.Probe`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Run \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getInitialDelaySeconds\n\nOptional. Number of seconds after the container has started before the\nprobe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum\nvalue for liveness probe is 3600. Maximum value for startup probe is 240.\n\n### setInitialDelaySeconds\n\nOptional. Number of seconds after the container has started before the\nprobe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum\nvalue for liveness probe is 3600. Maximum value for startup probe is 240.\n\n### getTimeoutSeconds\n\nOptional. Number of seconds after which the probe times out.\n\nDefaults to 1 second. Minimum value is 1. Maximum value is 3600.\nMust be smaller than period_seconds.\n\n### setTimeoutSeconds\n\nOptional. Number of seconds after which the probe times out.\n\nDefaults to 1 second. Minimum value is 1. Maximum value is 3600.\nMust be smaller than period_seconds.\n\n### getPeriodSeconds\n\nOptional. How often (in seconds) to perform the probe.\n\nDefault to 10 seconds. Minimum value is 1. Maximum value for liveness probe\nis 3600. Maximum value for startup probe is 240.\nMust be greater or equal than timeout_seconds.\n\n### setPeriodSeconds\n\nOptional. How often (in seconds) to perform the probe.\n\nDefault to 10 seconds. Minimum value is 1. Maximum value for liveness probe\nis 3600. Maximum value for startup probe is 240.\nMust be greater or equal than timeout_seconds.\n\n### getFailureThreshold\n\nOptional. Minimum consecutive failures for the probe to be considered\nfailed after having succeeded. Defaults to 3. Minimum value is 1.\n\n### setFailureThreshold\n\nOptional. Minimum consecutive failures for the probe to be considered\nfailed after having succeeded. Defaults to 3. Minimum value is 1.\n\n### getHttpGet\n\nOptional. HTTPGet specifies the http request to perform.\n\nExactly one of httpGet, tcpSocket, or grpc must be specified.\n\n### hasHttpGet\n\n### setHttpGet\n\nOptional. HTTPGet specifies the http request to perform.\n\nExactly one of httpGet, tcpSocket, or grpc must be specified.\n\n### getTcpSocket\n\nOptional. TCPSocket specifies an action involving a TCP port.\n\nExactly one of httpGet, tcpSocket, or grpc must be specified.\n\n### hasTcpSocket\n\n### setTcpSocket\n\nOptional. TCPSocket specifies an action involving a TCP port.\n\nExactly one of httpGet, tcpSocket, or grpc must be specified.\n\n### getGrpc\n\nOptional. GRPC specifies an action involving a gRPC port.\n\nExactly one of httpGet, tcpSocket, or grpc must be specified.\n\n### hasGrpc\n\n### setGrpc\n\nOptional. GRPC specifies an action involving a gRPC port.\n\nExactly one of httpGet, tcpSocket, or grpc must be specified.\n\n### getProbeType"]]
