Represents a HealthCheck.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.IHealthCheck);Constructs a new HealthCheck.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHealthCheck
Properties to set |
Properties
_checkIntervalSec
public _checkIntervalSec?: "checkIntervalSec";HealthCheck _checkIntervalSec.
_creationTimestamp
public _creationTimestamp?: "creationTimestamp";HealthCheck _creationTimestamp.
_description
public _description?: "description";HealthCheck _description.
_grpcHealthCheck
public _grpcHealthCheck?: "grpcHealthCheck";HealthCheck _grpcHealthCheck.
_healthyThreshold
public _healthyThreshold?: "healthyThreshold";HealthCheck _healthyThreshold.
_http2HealthCheck
public _http2HealthCheck?: "http2HealthCheck";HealthCheck _http2HealthCheck.
_httpHealthCheck
public _httpHealthCheck?: "httpHealthCheck";HealthCheck _httpHealthCheck.
_httpsHealthCheck
public _httpsHealthCheck?: "httpsHealthCheck";HealthCheck _httpsHealthCheck.
_id
public _id?: "id";HealthCheck _id.
_kind
public _kind?: "kind";HealthCheck _kind.
_logConfig
public _logConfig?: "logConfig";HealthCheck _logConfig.
_name
public _name?: "name";HealthCheck _name.
_region
public _region?: "region";HealthCheck _region.
_selfLink
public _selfLink?: "selfLink";HealthCheck _selfLink.
_sslHealthCheck
public _sslHealthCheck?: "sslHealthCheck";HealthCheck _sslHealthCheck.
_tcpHealthCheck
public _tcpHealthCheck?: "tcpHealthCheck";HealthCheck _tcpHealthCheck.
_timeoutSec
public _timeoutSec?: "timeoutSec";HealthCheck _timeoutSec.
_type
public _type?: "type";HealthCheck _type.
_unhealthyThreshold
public _unhealthyThreshold?: "unhealthyThreshold";HealthCheck _unhealthyThreshold.
checkIntervalSec
public checkIntervalSec?: (number|null);HealthCheck checkIntervalSec.
creationTimestamp
public creationTimestamp?: (string|null);HealthCheck creationTimestamp.
description
public description?: (string|null);HealthCheck description.
grpcHealthCheck
public grpcHealthCheck?: (google.cloud.compute.v1.IGRPCHealthCheck|null);HealthCheck grpcHealthCheck.
healthyThreshold
public healthyThreshold?: (number|null);HealthCheck healthyThreshold.
http2HealthCheck
public http2HealthCheck?: (google.cloud.compute.v1.IHTTP2HealthCheck|null);HealthCheck http2HealthCheck.
httpHealthCheck
public httpHealthCheck?: (google.cloud.compute.v1.IHTTPHealthCheck|null);HealthCheck httpHealthCheck.
httpsHealthCheck
public httpsHealthCheck?: (google.cloud.compute.v1.IHTTPSHealthCheck|null);HealthCheck httpsHealthCheck.
id
public id?: (number|Long|string|null);HealthCheck id.
kind
public kind?: (string|null);HealthCheck kind.
logConfig
public logConfig?: (google.cloud.compute.v1.IHealthCheckLogConfig|null);HealthCheck logConfig.
name
public name?: (string|null);HealthCheck name.
region
public region?: (string|null);HealthCheck region.
selfLink
public selfLink?: (string|null);HealthCheck selfLink.
sourceRegions
public sourceRegions: string[];HealthCheck sourceRegions.
sslHealthCheck
public sslHealthCheck?: (google.cloud.compute.v1.ISSLHealthCheck|null);HealthCheck sslHealthCheck.
tcpHealthCheck
public tcpHealthCheck?: (google.cloud.compute.v1.ITCPHealthCheck|null);HealthCheck tcpHealthCheck.
timeoutSec
public timeoutSec?: (number|null);HealthCheck timeoutSec.
type
public type?: (string|null);HealthCheck type.
unhealthyThreshold
public unhealthyThreshold?: (number|null);HealthCheck unhealthyThreshold.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.IHealthCheck): google.cloud.compute.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.cloud.compute.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.cloud.compute.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.cloud.compute.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.cloud.compute.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.cloud.compute.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.cloud.compute.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) |
|