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

Represents an InstanceProperties.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new InstanceProperties.

Parameter
Name Description
properties IInstanceProperties

Properties to set

Properties

_advancedMachineFeatures

public _advancedMachineFeatures?: "advancedMachineFeatures";

InstanceProperties _advancedMachineFeatures.

_canIpForward

public _canIpForward?: "canIpForward";

InstanceProperties _canIpForward.

_confidentialInstanceConfig

public _confidentialInstanceConfig?: "confidentialInstanceConfig";

InstanceProperties _confidentialInstanceConfig.

_description

public _description?: "description";

InstanceProperties _description.

_keyRevocationActionType

public _keyRevocationActionType?: "keyRevocationActionType";

InstanceProperties _keyRevocationActionType.

_machineType

public _machineType?: "machineType";

InstanceProperties _machineType.

_metadata

public _metadata?: "metadata";

InstanceProperties _metadata.

_minCpuPlatform

public _minCpuPlatform?: "minCpuPlatform";

InstanceProperties _minCpuPlatform.

_networkPerformanceConfig

public _networkPerformanceConfig?: "networkPerformanceConfig";

InstanceProperties _networkPerformanceConfig.

_privateIpv6GoogleAccess

public _privateIpv6GoogleAccess?: "privateIpv6GoogleAccess";

InstanceProperties _privateIpv6GoogleAccess.

_reservationAffinity

public _reservationAffinity?: "reservationAffinity";

InstanceProperties _reservationAffinity.

_scheduling

public _scheduling?: "scheduling";

InstanceProperties _scheduling.

_shieldedInstanceConfig

public _shieldedInstanceConfig?: "shieldedInstanceConfig";

InstanceProperties _shieldedInstanceConfig.

_tags

public _tags?: "tags";

InstanceProperties _tags.

advancedMachineFeatures

public advancedMachineFeatures?: (google.cloud.compute.v1.IAdvancedMachineFeatures|null);

InstanceProperties advancedMachineFeatures.

canIpForward

public canIpForward?: (boolean|null);

InstanceProperties canIpForward.

confidentialInstanceConfig

public confidentialInstanceConfig?: (google.cloud.compute.v1.IConfidentialInstanceConfig|null);

InstanceProperties confidentialInstanceConfig.

description

public description?: (string|null);

InstanceProperties description.

disks

public disks: google.cloud.compute.v1.IAttachedDisk[];

InstanceProperties disks.

guestAccelerators

public guestAccelerators: google.cloud.compute.v1.IAcceleratorConfig[];

InstanceProperties guestAccelerators.

keyRevocationActionType

public keyRevocationActionType?: (string|null);

InstanceProperties keyRevocationActionType.

labels

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

InstanceProperties labels.

machineType

public machineType?: (string|null);

InstanceProperties machineType.

metadata

public metadata?: (google.cloud.compute.v1.IMetadata|null);

InstanceProperties metadata.

minCpuPlatform

public minCpuPlatform?: (string|null);

InstanceProperties minCpuPlatform.

networkInterfaces

public networkInterfaces: google.cloud.compute.v1.INetworkInterface[];

InstanceProperties networkInterfaces.

networkPerformanceConfig

public networkPerformanceConfig?: (google.cloud.compute.v1.INetworkPerformanceConfig|null);

InstanceProperties networkPerformanceConfig.

privateIpv6GoogleAccess

public privateIpv6GoogleAccess?: (string|null);

InstanceProperties privateIpv6GoogleAccess.

reservationAffinity

public reservationAffinity?: (google.cloud.compute.v1.IReservationAffinity|null);

InstanceProperties reservationAffinity.

resourceManagerTags

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

InstanceProperties resourceManagerTags.

resourcePolicies

public resourcePolicies: string[];

InstanceProperties resourcePolicies.

scheduling

public scheduling?: (google.cloud.compute.v1.IScheduling|null);

InstanceProperties scheduling.

serviceAccounts

public serviceAccounts: google.cloud.compute.v1.IServiceAccount[];

InstanceProperties serviceAccounts.

shieldedInstanceConfig

public shieldedInstanceConfig?: (google.cloud.compute.v1.IShieldedInstanceConfig|null);

InstanceProperties shieldedInstanceConfig.

tags

public tags?: (google.cloud.compute.v1.ITags|null);

InstanceProperties tags.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IInstanceProperties): google.cloud.compute.v1.InstanceProperties;

Creates a new InstanceProperties instance using the specified properties.

Parameter
Name Description
properties IInstanceProperties

Properties to set

Returns
Type Description
InstanceProperties

InstanceProperties instance

decode(reader, length)

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

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

InstanceProperties

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
InstanceProperties

InstanceProperties

encode(message, writer)

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

Encodes the specified InstanceProperties message. Does not implicitly messages.

Parameters
Name Description
message IInstanceProperties

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

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

Parameters
Name Description
message IInstanceProperties

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

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

InstanceProperties

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for InstanceProperties

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message InstanceProperties

InstanceProperties

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