Class protos.google.cloud.run.v2.Probe (2.1.0)
Represents a Probe.
Package
@google-cloud/runConstructors
(constructor)(properties)
constructor(properties?:google.cloud.run.v2.IProbe);Constructs a new Probe.
| Parameter | |
|---|---|
| Name | Description |
properties | IProbeProperties to set |
Properties
failureThreshold
publicfailureThreshold:number;Probe failureThreshold.
grpc
publicgrpc?:(google.cloud.run.v2.IGRPCAction|null);Probe grpc.
httpGet
publichttpGet?:(google.cloud.run.v2.IHTTPGetAction|null);Probe httpGet.
initialDelaySeconds
publicinitialDelaySeconds:number;Probe initialDelaySeconds.
periodSeconds
publicperiodSeconds:number;Probe periodSeconds.
probeType
publicprobeType?:("httpGet"|"tcpSocket"|"grpc");Probe probeType.
tcpSocket
publictcpSocket?:(google.cloud.run.v2.ITCPSocketAction|null);Probe tcpSocket.
timeoutSeconds
publictimeoutSeconds:number;Probe timeoutSeconds.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.run.v2.IProbe):google.cloud.run.v2.Probe;Creates a new Probe instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IProbeProperties to set |
| Returns | |
|---|---|
| Type | Description |
Probe | Probe instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.run.v2.Probe;Decodes a Probe message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Probe | Probe |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.run.v2.Probe;Decodes a Probe message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Probe | Probe |
encode(message, writer)
publicstaticencode(message:google.cloud.run.v2.IProbe,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Probe message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IProbeProbe message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.cloud.run.v2.IProbe,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Probe message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IProbeProbe message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.cloud.run.v2.Probe;Creates a Probe message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object | { [k: string]: any }Plain object |
| Returns | |
|---|---|
| Type | Description |
Probe | Probe |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for Probe
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this Probe to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.cloud.run.v2.Probe,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a Probe message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | ProbeProbe |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a Probe message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.