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

Represents an InstanceGroupManager.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new InstanceGroupManager.

Parameter
Name Description
properties IInstanceGroupManager

Properties to set

Properties

_allInstancesConfig

public _allInstancesConfig?: "allInstancesConfig";

InstanceGroupManager _allInstancesConfig.

_baseInstanceName

public _baseInstanceName?: "baseInstanceName";

InstanceGroupManager _baseInstanceName.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

InstanceGroupManager _creationTimestamp.

_currentActions

public _currentActions?: "currentActions";

InstanceGroupManager _currentActions.

_description

public _description?: "description";

InstanceGroupManager _description.

_distributionPolicy

public _distributionPolicy?: "distributionPolicy";

InstanceGroupManager _distributionPolicy.

_fingerprint

public _fingerprint?: "fingerprint";

InstanceGroupManager _fingerprint.

_id

public _id?: "id";

InstanceGroupManager _id.

_instanceGroup

public _instanceGroup?: "instanceGroup";

InstanceGroupManager _instanceGroup.

_instanceLifecyclePolicy

public _instanceLifecyclePolicy?: "instanceLifecyclePolicy";

InstanceGroupManager _instanceLifecyclePolicy.

_instanceTemplate

public _instanceTemplate?: "instanceTemplate";

InstanceGroupManager _instanceTemplate.

_kind

public _kind?: "kind";

InstanceGroupManager _kind.

_listManagedInstancesResults

public _listManagedInstancesResults?: "listManagedInstancesResults";

InstanceGroupManager _listManagedInstancesResults.

_name

public _name?: "name";

InstanceGroupManager _name.

_region

public _region?: "region";

InstanceGroupManager _region.

public _selfLink?: "selfLink";

InstanceGroupManager _selfLink.

_statefulPolicy

public _statefulPolicy?: "statefulPolicy";

InstanceGroupManager _statefulPolicy.

_status

public _status?: "status";

InstanceGroupManager _status.

_targetSize

public _targetSize?: "targetSize";

InstanceGroupManager _targetSize.

_updatePolicy

public _updatePolicy?: "updatePolicy";

InstanceGroupManager _updatePolicy.

_zone

public _zone?: "zone";

InstanceGroupManager _zone.

allInstancesConfig

public allInstancesConfig?: (google.cloud.compute.v1.IInstanceGroupManagerAllInstancesConfig|null);

InstanceGroupManager allInstancesConfig.

autoHealingPolicies

public autoHealingPolicies: google.cloud.compute.v1.IInstanceGroupManagerAutoHealingPolicy[];

InstanceGroupManager autoHealingPolicies.

baseInstanceName

public baseInstanceName?: (string|null);

InstanceGroupManager baseInstanceName.

creationTimestamp

public creationTimestamp?: (string|null);

InstanceGroupManager creationTimestamp.

currentActions

public currentActions?: (google.cloud.compute.v1.IInstanceGroupManagerActionsSummary|null);

InstanceGroupManager currentActions.

description

public description?: (string|null);

InstanceGroupManager description.

distributionPolicy

public distributionPolicy?: (google.cloud.compute.v1.IDistributionPolicy|null);

InstanceGroupManager distributionPolicy.

fingerprint

public fingerprint?: (string|null);

InstanceGroupManager fingerprint.

id

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

InstanceGroupManager id.

instanceGroup

public instanceGroup?: (string|null);

InstanceGroupManager instanceGroup.

instanceLifecyclePolicy

public instanceLifecyclePolicy?: (google.cloud.compute.v1.IInstanceGroupManagerInstanceLifecyclePolicy|null);

InstanceGroupManager instanceLifecyclePolicy.

instanceTemplate

public instanceTemplate?: (string|null);

InstanceGroupManager instanceTemplate.

kind

public kind?: (string|null);

InstanceGroupManager kind.

listManagedInstancesResults

public listManagedInstancesResults?: (string|null);

InstanceGroupManager listManagedInstancesResults.

name

public name?: (string|null);

InstanceGroupManager name.

namedPorts

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

InstanceGroupManager namedPorts.

region

public region?: (string|null);

InstanceGroupManager region.

public selfLink?: (string|null);

InstanceGroupManager selfLink.

statefulPolicy

public statefulPolicy?: (google.cloud.compute.v1.IStatefulPolicy|null);

InstanceGroupManager statefulPolicy.

status

public status?: (google.cloud.compute.v1.IInstanceGroupManagerStatus|null);

InstanceGroupManager status.

targetPools

public targetPools: string[];

InstanceGroupManager targetPools.

targetSize

public targetSize?: (number|null);

InstanceGroupManager targetSize.

updatePolicy

public updatePolicy?: (google.cloud.compute.v1.IInstanceGroupManagerUpdatePolicy|null);

InstanceGroupManager updatePolicy.

versions

public versions: google.cloud.compute.v1.IInstanceGroupManagerVersion[];

InstanceGroupManager versions.

zone

public zone?: (string|null);

InstanceGroupManager zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IInstanceGroupManager): google.cloud.compute.v1.InstanceGroupManager;

Creates a new InstanceGroupManager instance using the specified properties.

Parameter
Name Description
properties IInstanceGroupManager

Properties to set

Returns
Type Description
InstanceGroupManager

InstanceGroupManager instance

decode(reader, length)

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

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

InstanceGroupManager

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
InstanceGroupManager

InstanceGroupManager

encode(message, writer)

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

Encodes the specified InstanceGroupManager message. Does not implicitly messages.

Parameters
Name Description
message IInstanceGroupManager

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

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

Parameters
Name Description
message IInstanceGroupManager

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

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

InstanceGroupManager

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for InstanceGroupManager

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message InstanceGroupManager

InstanceGroupManager

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