Class protos.google.cloud.compute.v1.TargetPool (3.5.1)

Represents a TargetPool.

Package

Constructors

(constructor)(properties)

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

Constructs a new TargetPool.

Parameter

Name	Description
properties	`ITargetPool` Properties to set

Properties

_backupPool

public _backupPool?: "backupPool";

TargetPool _backupPool.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

TargetPool _creationTimestamp.

_description

public _description?: "description";

TargetPool _description.

_failoverRatio

public _failoverRatio?: "failoverRatio";

TargetPool _failoverRatio.

_id

public _id?: "id";

TargetPool _id.

_kind

public _kind?: "kind";

TargetPool _kind.

_name

public _name?: "name";

TargetPool _name.

_region

public _region?: "region";

TargetPool _region.

_selfLink

public _selfLink?: "selfLink";

TargetPool _selfLink.

_sessionAffinity

public _sessionAffinity?: "sessionAffinity";

TargetPool _sessionAffinity.

backupPool

public backupPool?: (string|null);

TargetPool backupPool.

creationTimestamp

public creationTimestamp?: (string|null);

TargetPool creationTimestamp.

description

public description?: (string|null);

TargetPool description.

failoverRatio

public failoverRatio?: (number|null);

TargetPool failoverRatio.

healthChecks

public healthChecks: string[];

TargetPool healthChecks.

id

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

TargetPool id.

instances

public instances: string[];

TargetPool instances.

kind

public kind?: (string|null);

TargetPool kind.

name

public name?: (string|null);

TargetPool name.

region

public region?: (string|null);

TargetPool region.

selfLink

public selfLink?: (string|null);

TargetPool selfLink.

sessionAffinity

public sessionAffinity?: (string|null);

TargetPool sessionAffinity.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ITargetPool): google.cloud.compute.v1.TargetPool;

Creates a new TargetPool instance using the specified properties.

Parameter

Name	Description
properties	`ITargetPool` Properties to set

Returns

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

decode(reader, length)

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

Decodes a TargetPool 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.TargetPool	TargetPool

decodeDelimited(reader)

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

Decodes a TargetPool 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.TargetPool	TargetPool

encode(message, writer)

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

Encodes the specified TargetPool message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`ITargetPool` TargetPool 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.TargetPool;

Creates a TargetPool 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.TargetPool	TargetPool

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TargetPool

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

Returns

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

toObject(message, options)

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

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

Parameters

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