Constructor
new HealthStatus(propertiesopt)
Constructs a new HealthStatus.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.compute.v1.IHealthStatus |
<optional> |
Properties to set |
- Implements:
-
- IHealthStatus
Members
_forwardingRule
HealthStatus _forwardingRule.
_forwardingRuleIp
HealthStatus _forwardingRuleIp.
_healthState
HealthStatus _healthState.
_instance
HealthStatus _instance.
_ipAddress
HealthStatus _ipAddress.
_port
HealthStatus _port.
_weight
HealthStatus _weight.
_weightError
HealthStatus _weightError.
annotations
HealthStatus annotations.
forwardingRule
HealthStatus forwardingRule.
forwardingRuleIp
HealthStatus forwardingRuleIp.
healthState
HealthStatus healthState.
instance
HealthStatus instance.
ipAddress
HealthStatus ipAddress.
port
HealthStatus port.
weight
HealthStatus weight.
weightError
HealthStatus weightError.
HealthState
HealthState enum.
Properties:
| Name | Type | Description |
|---|---|---|
UNDEFINED_HEALTH_STATE |
number |
UNDEFINED_HEALTH_STATE value |
HEALTHY |
number |
HEALTHY value |
UNHEALTHY |
number |
UNHEALTHY value |
WeightError
WeightError enum.
Properties:
| Name | Type | Description |
|---|---|---|
UNDEFINED_WEIGHT_ERROR |
number |
UNDEFINED_WEIGHT_ERROR value |
INVALID_WEIGHT |
number |
INVALID_WEIGHT value |
MISSING_WEIGHT |
number |
MISSING_WEIGHT value |
UNAVAILABLE_WEIGHT |
number |
UNAVAILABLE_WEIGHT value |
WEIGHT_NONE |
number |
WEIGHT_NONE value |
Methods
toJSON() → {Object.<string, *>}
Converts this HealthStatus to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.compute.v1.HealthStatus}
Creates a new HealthStatus instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.compute.v1.IHealthStatus |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.compute.v1.HealthStatus |
HealthStatus instance |
(static) decode(reader, lengthopt) → {google.cloud.compute.v1.HealthStatus}
Decodes a HealthStatus 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.HealthStatus |
HealthStatus |
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.HealthStatus}
Decodes a HealthStatus 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.HealthStatus |
HealthStatus |
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 HealthStatus message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.compute.v1.IHealthStatus |
HealthStatus 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 HealthStatus message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.compute.v1.IHealthStatus |
HealthStatus 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.HealthStatus}
Creates a HealthStatus 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.HealthStatus |
HealthStatus |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for HealthStatus
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 HealthStatus message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.compute.v1.HealthStatus |
HealthStatus |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a HealthStatus message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|