Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.compute.v1.HealthStatus (3.1.2)

Represents a HealthStatus.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IHealthStatus);

Constructs a new HealthStatus.

Parameter

Name	Description
properties	`IHealthStatus` Properties to set

Properties

_forwardingRule

public _forwardingRule?: "forwardingRule";

HealthStatus _forwardingRule.

_forwardingRuleIp

public _forwardingRuleIp?: "forwardingRuleIp";

HealthStatus _forwardingRuleIp.

_healthState

public _healthState?: "healthState";

HealthStatus _healthState.

_instance

public _instance?: "instance";

HealthStatus _instance.

_ipAddress

public _ipAddress?: "ipAddress";

HealthStatus _ipAddress.

_port

public _port?: "port";

HealthStatus _port.

_weight

public _weight?: "weight";

HealthStatus _weight.

_weightError

public _weightError?: "weightError";

HealthStatus _weightError.

annotations

public annotations: { [k: string]: string };

HealthStatus annotations.

forwardingRule

public forwardingRule?: (string|null);

HealthStatus forwardingRule.

forwardingRuleIp

public forwardingRuleIp?: (string|null);

HealthStatus forwardingRuleIp.

healthState

public healthState?: (string|null);

HealthStatus healthState.

instance

public instance?: (string|null);

HealthStatus instance.

ipAddress

public ipAddress?: (string|null);

HealthStatus ipAddress.

port

public port?: (number|null);

HealthStatus port.

weight

public weight?: (string|null);

HealthStatus weight.

weightError

public weightError?: (string|null);

HealthStatus weightError.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IHealthStatus): google.cloud.compute.v1.HealthStatus;

Creates a new HealthStatus instance using the specified properties.

Parameter

Name	Description
properties	`IHealthStatus` Properties to set

Returns

Type	Description
google.cloud.compute.v1.HealthStatus	HealthStatus instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.HealthStatus;

Decodes a HealthStatus message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.compute.v1.HealthStatus	HealthStatus

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.HealthStatus;

Decodes a HealthStatus message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.compute.v1.HealthStatus	HealthStatus

encode(message, writer)

public static encode(message: google.cloud.compute.v1.IHealthStatus, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified HealthStatus message. Does not implicitly messages.

Parameters

Name	Description
message	`IHealthStatus` HealthStatus 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.IHealthStatus, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified HealthStatus message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IHealthStatus` HealthStatus 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.HealthStatus;

Creates a HealthStatus 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
google.cloud.compute.v1.HealthStatus	HealthStatus

toJSON()

public toJSON(): { [k: string]: any };

Converts this HealthStatus to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.HealthStatus, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a HealthStatus message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.compute.v1.HealthStatus` HealthStatus
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 HealthStatus message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not