Class protos.google.cloud.run.v2.Probe (1.5.0)

Represents a Probe.

Package

@google-cloud/run

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IProbe 
 ); 
 

Constructs a new Probe.

Parameter
Name
Description
properties
IProbe

Properties to set

Properties

failureThreshold

  public 
  
 failureThreshold 
 : 
  
 number 
 ; 
 

Probe failureThreshold.

grpc

  public 
  
 grpc 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IGRPCAction 
 | 
 null 
 ); 
 

Probe grpc.

httpGet

  public 
  
 httpGet 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IHTTPGetAction 
 | 
 null 
 ); 
 

Probe httpGet.

initialDelaySeconds

  public 
  
 initialDelaySeconds 
 : 
  
 number 
 ; 
 

Probe initialDelaySeconds.

periodSeconds

  public 
  
 periodSeconds 
 : 
  
 number 
 ; 
 

Probe periodSeconds.

probeType

  public 
  
 probeType 
 ?: 
  
 ( 
 "httpGet" 
 | 
 "tcpSocket" 
 | 
 "grpc" 
 ); 
 

Probe probeType.

tcpSocket

  public 
  
 tcpSocket 
 ?: 
  
 ( 
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ITCPSocketAction 
 | 
 null 
 ); 
 

Probe tcpSocket.

timeoutSeconds

  public 
  
 timeoutSeconds 
 : 
  
 number 
 ; 
 

Probe timeoutSeconds.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IProbe 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Probe 
 ; 
 

Creates a new Probe instance using the specified properties.

Parameter
Name
Description
properties
IProbe

Properties to set

Returns
Type
Description

Probe instance

decode(reader, length)

  public 
  
 static 
  
 decode 
 ( 
 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
number

Message length if known beforehand

Returns
Type
Description

Probe

decodeDelimited(reader)

  public 
  
 static 
  
 decodeDelimited 
 ( 
 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

encode(message, writer)

  public 
  
 static 
  
 encode 
 ( 
 message 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IProbe 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

Encodes the specified Probe message. Does not implicitly messages.

Parameters
Name
Description
message
IProbe

Probe message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

  public 
  
 static 
  
 encodeDelimited 
 ( 
 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
IProbe

Probe message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

fromObject(object)

  public 
  
 static 
  
 fromObject 
 ( 
 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

getTypeUrl(typeUrlPrefix)

  public 
  
 static 
  
 getTypeUrl 
 ( 
 typeUrlPrefix 
 ?: 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Gets the default type url for Probe

Parameter
Name
Description
typeUrlPrefix
string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type
Description
string

The default type url

toJSON()

  public 
  
 toJSON 
 () 
 : 
  
 { 
  
 [ 
 k 
 : 
  
 string 
 ] 
 : 
  
 any 
  
 }; 
 

Converts this Probe to JSON.

Returns
Type
Description
{ [k: string]: any }

JSON object

toObject(message, options)

  public 
  
 static 
  
 toObject 
 ( 
 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
Probe

Probe

options
$protobuf.IConversionOptions

Conversion options

Returns
Type
Description
{ [k: string]: any }

Plain object

verify(message)

  public 
  
 static 
  
 verify 
 ( 
 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)

null if valid, otherwise the reason why it is not

Design a Mobile Site
View Site in Mobile | Classic
Share by: