Class protos.google.cloud.compute.v1.TargetPoolAggregatedList (4.5.0)

Represents a TargetPoolAggregatedList.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new TargetPoolAggregatedList.

Parameter
Name Description
properties ITargetPoolAggregatedList

Properties to set

Properties

_id

public _id?: "id";

TargetPoolAggregatedList _id.

_kind

public _kind?: "kind";

TargetPoolAggregatedList _kind.

_nextPageToken

public _nextPageToken?: "nextPageToken";

TargetPoolAggregatedList _nextPageToken.

public _selfLink?: "selfLink";

TargetPoolAggregatedList _selfLink.

_warning

public _warning?: "warning";

TargetPoolAggregatedList _warning.

id

public id?: (string|null);

TargetPoolAggregatedList id.

items

public items: { [k: string]: google.cloud.compute.v1.ITargetPoolsScopedList };

TargetPoolAggregatedList items.

kind

public kind?: (string|null);

TargetPoolAggregatedList kind.

nextPageToken

public nextPageToken?: (string|null);

TargetPoolAggregatedList nextPageToken.

public selfLink?: (string|null);

TargetPoolAggregatedList selfLink.

unreachables

public unreachables: string[];

TargetPoolAggregatedList unreachables.

warning

public warning?: (google.cloud.compute.v1.IWarning|null);

TargetPoolAggregatedList warning.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ITargetPoolAggregatedList): google.cloud.compute.v1.TargetPoolAggregatedList;

Creates a new TargetPoolAggregatedList instance using the specified properties.

Parameter
Name Description
properties ITargetPoolAggregatedList

Properties to set

Returns
Type Description
TargetPoolAggregatedList

TargetPoolAggregatedList instance

decode(reader, length)

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

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

TargetPoolAggregatedList

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
TargetPoolAggregatedList

TargetPoolAggregatedList

encode(message, writer)

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

Encodes the specified TargetPoolAggregatedList message. Does not implicitly messages.

Parameters
Name Description
message ITargetPoolAggregatedList

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

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

Parameters
Name Description
message ITargetPoolAggregatedList

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

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

TargetPoolAggregatedList

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TargetPoolAggregatedList

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message TargetPoolAggregatedList

TargetPoolAggregatedList

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