Class protos.google.cloud.compute.v1.HealthCheckService (4.8.0)

Represents a HealthCheckService.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new HealthCheckService.

Parameter
Name Description
properties IHealthCheckService

Properties to set

Properties

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

HealthCheckService _creationTimestamp.

_description

public _description?: "description";

HealthCheckService _description.

_fingerprint

public _fingerprint?: "fingerprint";

HealthCheckService _fingerprint.

_healthStatusAggregationPolicy

public _healthStatusAggregationPolicy?: "healthStatusAggregationPolicy";

HealthCheckService _healthStatusAggregationPolicy.

_id

public _id?: "id";

HealthCheckService _id.

_kind

public _kind?: "kind";

HealthCheckService _kind.

_name

public _name?: "name";

HealthCheckService _name.

_region

public _region?: "region";

HealthCheckService _region.

public _selfLink?: "selfLink";

HealthCheckService _selfLink.

creationTimestamp

public creationTimestamp?: (string|null);

HealthCheckService creationTimestamp.

description

public description?: (string|null);

HealthCheckService description.

fingerprint

public fingerprint?: (string|null);

HealthCheckService fingerprint.

healthChecks

public healthChecks: string[];

HealthCheckService healthChecks.

healthStatusAggregationPolicy

public healthStatusAggregationPolicy?: (string|null);

HealthCheckService healthStatusAggregationPolicy.

id

public id?: (number|Long|string|null);

HealthCheckService id.

kind

public kind?: (string|null);

HealthCheckService kind.

name

public name?: (string|null);

HealthCheckService name.

networkEndpointGroups

public networkEndpointGroups: string[];

HealthCheckService networkEndpointGroups.

notificationEndpoints

public notificationEndpoints: string[];

HealthCheckService notificationEndpoints.

region

public region?: (string|null);

HealthCheckService region.

public selfLink?: (string|null);

HealthCheckService selfLink.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IHealthCheckService): google.cloud.compute.v1.HealthCheckService;

Creates a new HealthCheckService instance using the specified properties.

Parameter
Name Description
properties IHealthCheckService

Properties to set

Returns
Type Description
HealthCheckService

HealthCheckService instance

decode(reader, length)

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

Decodes a HealthCheckService 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
HealthCheckService

HealthCheckService

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HealthCheckService

HealthCheckService

encode(message, writer)

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

Encodes the specified HealthCheckService message. Does not implicitly messages.

Parameters
Name Description
message IHealthCheckService

HealthCheckService 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.IHealthCheckService, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IHealthCheckService

HealthCheckService 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.HealthCheckService;

Creates a HealthCheckService 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
HealthCheckService

HealthCheckService

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for HealthCheckService

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 HealthCheckService to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message HealthCheckService

HealthCheckService

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 HealthCheckService 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