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

Represents an Autoscaler.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new Autoscaler.

Parameter
Name Description
properties IAutoscaler

Properties to set

Properties

_autoscalingPolicy

public _autoscalingPolicy?: "autoscalingPolicy";

Autoscaler _autoscalingPolicy.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

Autoscaler _creationTimestamp.

_description

public _description?: "description";

Autoscaler _description.

_id

public _id?: "id";

Autoscaler _id.

_kind

public _kind?: "kind";

Autoscaler _kind.

_name

public _name?: "name";

Autoscaler _name.

_recommendedSize

public _recommendedSize?: "recommendedSize";

Autoscaler _recommendedSize.

_region

public _region?: "region";

Autoscaler _region.

public _selfLink?: "selfLink";

Autoscaler _selfLink.

_status

public _status?: "status";

Autoscaler _status.

_target

public _target?: "target";

Autoscaler _target.

_zone

public _zone?: "zone";

Autoscaler _zone.

autoscalingPolicy

public autoscalingPolicy?: (google.cloud.compute.v1.IAutoscalingPolicy|null);

Autoscaler autoscalingPolicy.

creationTimestamp

public creationTimestamp?: (string|null);

Autoscaler creationTimestamp.

description

public description?: (string|null);

Autoscaler description.

id

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

Autoscaler id.

kind

public kind?: (string|null);

Autoscaler kind.

name

public name?: (string|null);

Autoscaler name.

recommendedSize

public recommendedSize?: (number|null);

Autoscaler recommendedSize.

region

public region?: (string|null);

Autoscaler region.

scalingScheduleStatus

public scalingScheduleStatus: { [k: string]: google.cloud.compute.v1.IScalingScheduleStatus };

Autoscaler scalingScheduleStatus.

public selfLink?: (string|null);

Autoscaler selfLink.

status

public status?: (string|null);

Autoscaler status.

statusDetails

public statusDetails: google.cloud.compute.v1.IAutoscalerStatusDetails[];

Autoscaler statusDetails.

target

public target?: (string|null);

Autoscaler target.

zone

public zone?: (string|null);

Autoscaler zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IAutoscaler): google.cloud.compute.v1.Autoscaler;

Creates a new Autoscaler instance using the specified properties.

Parameter
Name Description
properties IAutoscaler

Properties to set

Returns
Type Description
Autoscaler

Autoscaler instance

decode(reader, length)

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

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

Autoscaler

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Autoscaler

Autoscaler

encode(message, writer)

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

Encodes the specified Autoscaler message. Does not implicitly messages.

Parameters
Name Description
message IAutoscaler

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

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

Parameters
Name Description
message IAutoscaler

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

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

Autoscaler

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Autoscaler

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Autoscaler

Autoscaler

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