Represents a HealthCheck.
Package
@google-cloud/appengine-adminConstructors
(constructor)(properties)
constructor(properties?: google.appengine.v1.IHealthCheck);Constructs a new HealthCheck.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHealthCheck
Properties to set |
Properties
checkInterval
public checkInterval?: (google.protobuf.IDuration|null);HealthCheck checkInterval.
disableHealthCheck
public disableHealthCheck: boolean;HealthCheck disableHealthCheck.
healthyThreshold
public healthyThreshold: number;HealthCheck healthyThreshold.
host
public host: string;HealthCheck host.
restartThreshold
public restartThreshold: number;HealthCheck restartThreshold.
timeout
public timeout?: (google.protobuf.IDuration|null);HealthCheck timeout.
unhealthyThreshold
public unhealthyThreshold: number;HealthCheck unhealthyThreshold.
Methods
create(properties)
public static create(properties?: google.appengine.v1.IHealthCheck): google.appengine.v1.HealthCheck;Creates a new HealthCheck instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHealthCheck
Properties to set |
| Returns | |
|---|---|
| Type | Description |
HealthCheck | HealthCheck instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.appengine.v1.HealthCheck;Decodes a HealthCheck 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 |
HealthCheck | HealthCheck |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.appengine.v1.HealthCheck;Decodes a HealthCheck message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
HealthCheck | HealthCheck |
encode(message, writer)
public static encode(message: google.appengine.v1.IHealthCheck, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HealthCheck message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHealthCheck
HealthCheck 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.appengine.v1.IHealthCheck, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HealthCheck message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHealthCheck
HealthCheck 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.appengine.v1.HealthCheck;Creates a HealthCheck 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 |
HealthCheck | HealthCheck |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for HealthCheck
| 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 HealthCheck to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.appengine.v1.HealthCheck, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a HealthCheck message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
HealthCheck
HealthCheck |
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 HealthCheck message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|