Class protos.google.cloud.compute.v1.InstanceGroup (4.3.0)

Represents an InstanceGroup.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new InstanceGroup.

Parameter
Name Description
properties IInstanceGroup

Properties to set

Properties

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

InstanceGroup _creationTimestamp.

_description

public _description?: "description";

InstanceGroup _description.

_fingerprint

public _fingerprint?: "fingerprint";

InstanceGroup _fingerprint.

_id

public _id?: "id";

InstanceGroup _id.

_kind

public _kind?: "kind";

InstanceGroup _kind.

_name

public _name?: "name";

InstanceGroup _name.

_network

public _network?: "network";

InstanceGroup _network.

_region

public _region?: "region";

InstanceGroup _region.

public _selfLink?: "selfLink";

InstanceGroup _selfLink.

_size

public _size?: "size";

InstanceGroup _size.

_subnetwork

public _subnetwork?: "subnetwork";

InstanceGroup _subnetwork.

_zone

public _zone?: "zone";

InstanceGroup _zone.

creationTimestamp

public creationTimestamp?: (string|null);

InstanceGroup creationTimestamp.

description

public description?: (string|null);

InstanceGroup description.

fingerprint

public fingerprint?: (string|null);

InstanceGroup fingerprint.

id

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

InstanceGroup id.

kind

public kind?: (string|null);

InstanceGroup kind.

name

public name?: (string|null);

InstanceGroup name.

namedPorts

public namedPorts: google.cloud.compute.v1.INamedPort[];

InstanceGroup namedPorts.

network

public network?: (string|null);

InstanceGroup network.

region

public region?: (string|null);

InstanceGroup region.

public selfLink?: (string|null);

InstanceGroup selfLink.

size

public size?: (number|null);

InstanceGroup size.

subnetwork

public subnetwork?: (string|null);

InstanceGroup subnetwork.

zone

public zone?: (string|null);

InstanceGroup zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IInstanceGroup): google.cloud.compute.v1.InstanceGroup;

Creates a new InstanceGroup instance using the specified properties.

Parameter
Name Description
properties IInstanceGroup

Properties to set

Returns
Type Description
InstanceGroup

InstanceGroup instance

decode(reader, length)

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

Decodes an InstanceGroup 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
InstanceGroup

InstanceGroup

decodeDelimited(reader)

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

Decodes an InstanceGroup message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
InstanceGroup

InstanceGroup

encode(message, writer)

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

Encodes the specified InstanceGroup message. Does not implicitly messages.

Parameters
Name Description
message IInstanceGroup

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

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

Parameters
Name Description
message IInstanceGroup

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

Creates an InstanceGroup 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
InstanceGroup

InstanceGroup

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for InstanceGroup

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message InstanceGroup

InstanceGroup

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 an InstanceGroup 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