Class protos.google.cloud.compute.v1.Image (4.1.0)

Represents an Image.

Package

Constructors

(constructor)(properties)

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

Constructs a new Image.

Parameter
Name	Description
`properties`	`IImage` Properties to set

Properties

_architecture

public _architecture?: "architecture";

Image _architecture.

_archiveSizeBytes

public _archiveSizeBytes?: "archiveSizeBytes";

Image _archiveSizeBytes.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

Image _creationTimestamp.

_deprecated

public _deprecated?: "deprecated";

Image _deprecated.

_description

public _description?: "description";

Image _description.

_diskSizeGb

public _diskSizeGb?: "diskSizeGb";

Image _diskSizeGb.

_family

public _family?: "family";

Image _family.

_id

public _id?: "id";

Image _id.

_imageEncryptionKey

public _imageEncryptionKey?: "imageEncryptionKey";

Image _imageEncryptionKey.

_kind

public _kind?: "kind";

Image _kind.

_labelFingerprint

public _labelFingerprint?: "labelFingerprint";

Image _labelFingerprint.

_name

public _name?: "name";

Image _name.

_rawDisk

public _rawDisk?: "rawDisk";

Image _rawDisk.

_satisfiesPzs

public _satisfiesPzs?: "satisfiesPzs";

Image _satisfiesPzs.

_selfLink

public _selfLink?: "selfLink";

Image _selfLink.

_shieldedInstanceInitialState

public _shieldedInstanceInitialState?: "shieldedInstanceInitialState";

Image _shieldedInstanceInitialState.

_sourceDisk

public _sourceDisk?: "sourceDisk";

Image _sourceDisk.

_sourceDiskEncryptionKey

public _sourceDiskEncryptionKey?: "sourceDiskEncryptionKey";

Image _sourceDiskEncryptionKey.

_sourceDiskId

public _sourceDiskId?: "sourceDiskId";

Image _sourceDiskId.

_sourceImage

public _sourceImage?: "sourceImage";

Image _sourceImage.

_sourceImageEncryptionKey

public _sourceImageEncryptionKey?: "sourceImageEncryptionKey";

Image _sourceImageEncryptionKey.

_sourceImageId

public _sourceImageId?: "sourceImageId";

Image _sourceImageId.

_sourceSnapshot

public _sourceSnapshot?: "sourceSnapshot";

Image _sourceSnapshot.

_sourceSnapshotEncryptionKey

public _sourceSnapshotEncryptionKey?: "sourceSnapshotEncryptionKey";

Image _sourceSnapshotEncryptionKey.

_sourceSnapshotId

public _sourceSnapshotId?: "sourceSnapshotId";

Image _sourceSnapshotId.

_sourceType

public _sourceType?: "sourceType";

Image _sourceType.

_status

public _status?: "status";

Image _status.

architecture

public architecture?: (string|null);

Image architecture.

archiveSizeBytes

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

Image archiveSizeBytes.

creationTimestamp

public creationTimestamp?: (string|null);

Image creationTimestamp.

deprecated

public deprecated?: (google.cloud.compute.v1.IDeprecationStatus|null);

Image deprecated.

description

public description?: (string|null);

Image description.

diskSizeGb

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

Image diskSizeGb.

family

public family?: (string|null);

Image family.

guestOsFeatures

public guestOsFeatures: google.cloud.compute.v1.IGuestOsFeature[];

Image guestOsFeatures.

id

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

Image id.

imageEncryptionKey

public imageEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);

Image imageEncryptionKey.

kind

public kind?: (string|null);

Image kind.

labelFingerprint

public labelFingerprint?: (string|null);

Image labelFingerprint.

labels

public labels: { [k: string]: string };

Image labels.

licenseCodes

public licenseCodes: (number|Long|string)[];

Image licenseCodes.

licenses

public licenses: string[];

Image licenses.

name

public name?: (string|null);

Image name.

rawDisk

public rawDisk?: (google.cloud.compute.v1.IRawDisk|null);

Image rawDisk.

satisfiesPzs

public satisfiesPzs?: (boolean|null);

Image satisfiesPzs.

selfLink

public selfLink?: (string|null);

Image selfLink.

shieldedInstanceInitialState

public shieldedInstanceInitialState?: (google.cloud.compute.v1.IInitialStateConfig|null);

Image shieldedInstanceInitialState.

sourceDisk

public sourceDisk?: (string|null);

Image sourceDisk.

sourceDiskEncryptionKey

public sourceDiskEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);

Image sourceDiskEncryptionKey.

sourceDiskId

public sourceDiskId?: (string|null);

Image sourceDiskId.

sourceImage

public sourceImage?: (string|null);

Image sourceImage.

sourceImageEncryptionKey

public sourceImageEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);

Image sourceImageEncryptionKey.

sourceImageId

public sourceImageId?: (string|null);

Image sourceImageId.

sourceSnapshot

public sourceSnapshot?: (string|null);

Image sourceSnapshot.

sourceSnapshotEncryptionKey

public sourceSnapshotEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);

Image sourceSnapshotEncryptionKey.

sourceSnapshotId

public sourceSnapshotId?: (string|null);

Image sourceSnapshotId.

sourceType

public sourceType?: (string|null);

Image sourceType.

status

public status?: (string|null);

Image status.

storageLocations

public storageLocations: string[];

Image storageLocations.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IImage): google.cloud.compute.v1.Image;

Creates a new Image instance using the specified properties.

Parameter
Name	Description
`properties`	`IImage` Properties to set

Returns
Type	Description
`Image`	Image instance

decode(reader, length)

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

Decodes an Image 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
`Image`	Image

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`Image`	Image

encode(message, writer)

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

Encodes the specified Image message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IImage` Image 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.IImage, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IImage` Image 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.Image;

Creates an Image 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
`Image`	Image

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Image

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

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`Image` Image
`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 Image 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