Class protos.google.cloud.compute.v1beta.HealthAggregationPolicy (6.9.0)

Represents a HealthAggregationPolicy.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1beta.IHealthAggregationPolicy);

Constructs a new HealthAggregationPolicy.

Parameter
Name Description
properties IHealthAggregationPolicy

Properties to set

Properties

creationTimestamp

public creationTimestamp?: (string|null);

HealthAggregationPolicy creationTimestamp.

description

public description?: (string|null);

HealthAggregationPolicy description.

fingerprint

public fingerprint?: (string|null);

HealthAggregationPolicy fingerprint.

healthyPercentThreshold

public healthyPercentThreshold?: (number|null);

HealthAggregationPolicy healthyPercentThreshold.

id

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

HealthAggregationPolicy id.

kind

public kind?: (string|null);

HealthAggregationPolicy kind.

minHealthyThreshold

public minHealthyThreshold?: (number|null);

HealthAggregationPolicy minHealthyThreshold.

name

public name?: (string|null);

HealthAggregationPolicy name.

policyType

public policyType?: (string|null);

HealthAggregationPolicy policyType.

region

public region?: (string|null);

HealthAggregationPolicy region.

public selfLink?: (string|null);

HealthAggregationPolicy selfLink.

selfLinkWithId

public selfLinkWithId?: (string|null);

HealthAggregationPolicy selfLinkWithId.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1beta.IHealthAggregationPolicy): google.cloud.compute.v1beta.HealthAggregationPolicy;

Creates a new HealthAggregationPolicy instance using the specified properties.

Parameter
Name Description
properties IHealthAggregationPolicy

Properties to set

Returns
Type Description
HealthAggregationPolicy

HealthAggregationPolicy instance

decode(reader, length)

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

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

HealthAggregationPolicy

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HealthAggregationPolicy

HealthAggregationPolicy

encode(message, writer)

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

Encodes the specified HealthAggregationPolicy message. Does not implicitly messages.

Parameters
Name Description
message IHealthAggregationPolicy

HealthAggregationPolicy 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.v1beta.IHealthAggregationPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IHealthAggregationPolicy

HealthAggregationPolicy 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.v1beta.HealthAggregationPolicy;

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

HealthAggregationPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HealthAggregationPolicy

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message HealthAggregationPolicy

HealthAggregationPolicy

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