App Engine v1 API - Class ReadinessCheck (2.3.0)

public sealed class ReadinessCheck : IMessage<ReadinessCheck>, IEquatable<ReadinessCheck>, IDeepCloneable<ReadinessCheck>, IBufferMessage, IMessage

Reference documentation and code samples for the App Engine v1 API class ReadinessCheck.

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.

Inheritance

object > ReadinessCheck

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

ReadinessCheck()

public ReadinessCheck()

ReadinessCheck(ReadinessCheck)

public ReadinessCheck(ReadinessCheck other)
Parameter
Name Description
other ReadinessCheck

Properties

AppStartTimeout

public Duration AppStartTimeout { get; set; }

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

Property Value
Type Description
Duration

CheckInterval

public Duration CheckInterval { get; set; }

Interval between health checks.

Property Value
Type Description
Duration

FailureThreshold

public uint FailureThreshold { get; set; }

Number of consecutive failed checks required before removing traffic.

Property Value
Type Description
uint

Host

public string Host { get; set; }

Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"

Property Value
Type Description
string

Path

public string Path { get; set; }

The request path.

Property Value
Type Description
string

SuccessThreshold

public uint SuccessThreshold { get; set; }

Number of consecutive successful checks required before receiving traffic.

Property Value
Type Description
uint

Timeout

public Duration Timeout { get; set; }

Time before the check is considered failed.

Property Value
Type Description
Duration