Constructor
new HealthCheck(propertiesopt)
Constructs a new HealthCheck.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.compute.v1.IHealthCheck |
<optional> |
Properties to set |
- Implements:
-
- IHealthCheck
Members
_checkIntervalSec
HealthCheck _checkIntervalSec.
_creationTimestamp
HealthCheck _creationTimestamp.
_description
HealthCheck _description.
_grpcHealthCheck
HealthCheck _grpcHealthCheck.
_healthyThreshold
HealthCheck _healthyThreshold.
_http2HealthCheck
HealthCheck _http2HealthCheck.
_httpHealthCheck
HealthCheck _httpHealthCheck.
_httpsHealthCheck
HealthCheck _httpsHealthCheck.
_id
HealthCheck _id.
_kind
HealthCheck _kind.
_logConfig
HealthCheck _logConfig.
_name
HealthCheck _name.
_region
HealthCheck _region.
_selfLink
HealthCheck _selfLink.
_sslHealthCheck
HealthCheck _sslHealthCheck.
_tcpHealthCheck
HealthCheck _tcpHealthCheck.
_timeoutSec
HealthCheck _timeoutSec.
_type
HealthCheck _type.
_unhealthyThreshold
HealthCheck _unhealthyThreshold.
checkIntervalSec
HealthCheck checkIntervalSec.
creationTimestamp
HealthCheck creationTimestamp.
description
HealthCheck description.
grpcHealthCheck
HealthCheck grpcHealthCheck.
healthyThreshold
HealthCheck healthyThreshold.
http2HealthCheck
HealthCheck http2HealthCheck.
httpHealthCheck
HealthCheck httpHealthCheck.
httpsHealthCheck
HealthCheck httpsHealthCheck.
id
HealthCheck id.
kind
HealthCheck kind.
logConfig
HealthCheck logConfig.
name
HealthCheck name.
region
HealthCheck region.
selfLink
HealthCheck selfLink.
sslHealthCheck
HealthCheck sslHealthCheck.
tcpHealthCheck
HealthCheck tcpHealthCheck.
timeoutSec
HealthCheck timeoutSec.
type
HealthCheck type.
unhealthyThreshold
HealthCheck unhealthyThreshold.
Type
Type enum.
Properties:
| Name | Type | Description |
|---|---|---|
UNDEFINED_TYPE |
number |
UNDEFINED_TYPE value |
GRPC |
number |
GRPC value |
HTTP |
number |
HTTP value |
HTTP2 |
number |
HTTP2 value |
HTTPS |
number |
HTTPS value |
INVALID |
number |
INVALID value |
SSL |
number |
SSL value |
TCP |
number |
TCP value |
Methods
toJSON() → {Object.<string, *>}
Converts this HealthCheck to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.compute.v1.HealthCheck}
Creates a new HealthCheck instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.compute.v1.IHealthCheck |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.compute.v1.HealthCheck |
HealthCheck instance |
(static) decode(reader, lengthopt) → {google.cloud.compute.v1.HealthCheck}
Decodes a HealthCheck message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.compute.v1.HealthCheck |
HealthCheck |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.compute.v1.HealthCheck}
Decodes a HealthCheck message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.compute.v1.HealthCheck |
HealthCheck |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified HealthCheck message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.compute.v1.IHealthCheck |
HealthCheck message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified HealthCheck message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.compute.v1.IHealthCheck |
HealthCheck message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.compute.v1.HealthCheck}
Creates a HealthCheck message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.compute.v1.HealthCheck |
HealthCheck |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for HealthCheck
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a HealthCheck message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.compute.v1.HealthCheck |
HealthCheck |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a HealthCheck message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|