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

Represents an InstanceTemplate.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new InstanceTemplate.

Parameter
NameDescription
properties IInstanceTemplate

Properties to set

Properties

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

InstanceTemplate _creationTimestamp.

_description

public _description?: "description";

InstanceTemplate _description.

_id

public _id?: "id";

InstanceTemplate _id.

_kind

public _kind?: "kind";

InstanceTemplate _kind.

_name

public _name?: "name";

InstanceTemplate _name.

_properties

public _properties?: "properties";

InstanceTemplate _properties.

_region

public _region?: "region";

InstanceTemplate _region.

public _selfLink?: "selfLink";

InstanceTemplate _selfLink.

_sourceInstance

public _sourceInstance?: "sourceInstance";

InstanceTemplate _sourceInstance.

_sourceInstanceParams

public _sourceInstanceParams?: "sourceInstanceParams";

InstanceTemplate _sourceInstanceParams.

creationTimestamp

public creationTimestamp?: (string|null);

InstanceTemplate creationTimestamp.

description

public description?: (string|null);

InstanceTemplate description.

id

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

InstanceTemplate id.

kind

public kind?: (string|null);

InstanceTemplate kind.

name

public name?: (string|null);

InstanceTemplate name.

properties

public properties?: (google.cloud.compute.v1.IInstanceProperties|null);

InstanceTemplate properties.

region

public region?: (string|null);

InstanceTemplate region.

public selfLink?: (string|null);

InstanceTemplate selfLink.

sourceInstance

public sourceInstance?: (string|null);

InstanceTemplate sourceInstance.

sourceInstanceParams

public sourceInstanceParams?: (google.cloud.compute.v1.ISourceInstanceParams|null);

InstanceTemplate sourceInstanceParams.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IInstanceTemplate): google.cloud.compute.v1.InstanceTemplate;

Creates a new InstanceTemplate instance using the specified properties.

Parameter
NameDescription
properties IInstanceTemplate

Properties to set

Returns
TypeDescription
InstanceTemplate

InstanceTemplate instance

decode(reader, length)

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

Decodes an InstanceTemplate message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
InstanceTemplate

InstanceTemplate

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
InstanceTemplate

InstanceTemplate

encode(message, writer)

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

Encodes the specified InstanceTemplate message. Does not implicitly messages.

Parameters
NameDescription
message IInstanceTemplate

InstanceTemplate message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IInstanceTemplate

InstanceTemplate message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.InstanceTemplate;

Creates an InstanceTemplate message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
InstanceTemplate

InstanceTemplate

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for InstanceTemplate

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this InstanceTemplate to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message InstanceTemplate

InstanceTemplate

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an InstanceTemplate message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not