Reference documentation and code samples for the Compute V1 Client class MachineType.
Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.
Generated from protobuf message google.cloud.compute.v1.MachineType
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ accelerators |
array<Google\Cloud\Compute\V1\Accelerators>
[Output Only] A list of accelerator configurations assigned to this machine type. |
↳ creation_timestamp |
string
[Output Only] Creation timestamp in RFC3339 text format. |
↳ deprecated |
Google\Cloud\Compute\V1\DeprecationStatus
[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable. |
↳ description |
string
[Output Only] An optional textual description of the resource. |
↳ guest_cpus |
int
[Output Only] The number of virtual CPUs that are available to the instance. |
↳ id |
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
↳ image_space_gb |
int
[Deprecated] This property is deprecated and will never be populated with any relevant values. |
↳ is_shared_cpu |
bool
[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. |
↳ kind |
string
[Output Only] The type of the resource. Always compute#machineType for machine types. |
↳ maximum_persistent_disks |
int
[Output Only] Maximum persistent disks allowed. |
↳ maximum_persistent_disks_size_gb |
int|string
[Output Only] Maximum total persistent disks size (GB) allowed. |
↳ memory_mb |
int
[Output Only] The amount of physical memory available to the instance, defined in MB. |
↳ name |
string
[Output Only] Name of the resource. |
↳ scratch_disks |
array<Google\Cloud\Compute\V1\ScratchDisks>
[Output Only] A list of extended scratch disks assigned to the instance. |
↳ self_link |
string
[Output Only] Server-defined URL for the resource. |
↳ zone |
string
[Output Only] The name of the zone where the machine type resides, such as us-central1-a. |
getAccelerators
[Output Only] A list of accelerator configurations assigned to this machine type.
Generated from protobuf field repeated .google.cloud.compute.v1.Accelerators accelerators = 269577064;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAccelerators
[Output Only] A list of accelerator configurations assigned to this machine type.
Generated from protobuf field repeated .google.cloud.compute.v1.Accelerators accelerators = 269577064;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\Accelerators>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
string | |
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeprecated
[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable.
Generated from protobuf field optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\DeprecationStatus|null | |
hasDeprecated
clearDeprecated
setDeprecated
[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable.
Generated from protobuf field optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\DeprecationStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
[Output Only] An optional textual description of the resource.
Generated from protobuf field optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
string | |
hasDescription
clearDescription
setDescription
[Output Only] An optional textual description of the resource.
Generated from protobuf field optional string description = 422937596;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGuestCpus
[Output Only] The number of virtual CPUs that are available to the instance.
Generated from protobuf field optional int32 guest_cpus = 393356754;
| Returns | |
|---|---|
| Type | Description |
int | |
hasGuestCpus
clearGuestCpus
setGuestCpus
[Output Only] The number of virtual CPUs that are available to the instance.
Generated from protobuf field optional int32 guest_cpus = 393356754;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Generated from protobuf field optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Generated from protobuf field optional uint64 id = 3355;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getImageSpaceGb
[Deprecated] This property is deprecated and will never be populated with any relevant values.
Generated from protobuf field optional int32 image_space_gb = 75331864;
| Returns | |
|---|---|
| Type | Description |
int | |
hasImageSpaceGb
clearImageSpaceGb
setImageSpaceGb
[Deprecated] This property is deprecated and will never be populated with any relevant values.
Generated from protobuf field optional int32 image_space_gb = 75331864;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIsSharedCpu
[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
Generated from protobuf field optional bool is_shared_cpu = 521399555;
| Returns | |
|---|---|
| Type | Description |
bool | |
hasIsSharedCpu
clearIsSharedCpu
setIsSharedCpu
[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
Generated from protobuf field optional bool is_shared_cpu = 521399555;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output Only] The type of the resource. Always compute#machineType for machine types.
Generated from protobuf field optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] The type of the resource. Always compute#machineType for machine types.
Generated from protobuf field optional string kind = 3292052;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaximumPersistentDisks
[Output Only] Maximum persistent disks allowed.
Generated from protobuf field optional int32 maximum_persistent_disks = 496220941;
| Returns | |
|---|---|
| Type | Description |
int | |
hasMaximumPersistentDisks
clearMaximumPersistentDisks
setMaximumPersistentDisks
[Output Only] Maximum persistent disks allowed.
Generated from protobuf field optional int32 maximum_persistent_disks = 496220941;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaximumPersistentDisksSizeGb
[Output Only] Maximum total persistent disks size (GB) allowed.
Generated from protobuf field optional int64 maximum_persistent_disks_size_gb = 154274471;
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasMaximumPersistentDisksSizeGb
clearMaximumPersistentDisksSizeGb
setMaximumPersistentDisksSizeGb
[Output Only] Maximum total persistent disks size (GB) allowed.
Generated from protobuf field optional int64 maximum_persistent_disks_size_gb = 154274471;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMemoryMb
[Output Only] The amount of physical memory available to the instance, defined in MB.
Generated from protobuf field optional int32 memory_mb = 116001171;
| Returns | |
|---|---|
| Type | Description |
int | |
hasMemoryMb
clearMemoryMb
setMemoryMb
[Output Only] The amount of physical memory available to the instance, defined in MB.
Generated from protobuf field optional int32 memory_mb = 116001171;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
[Output Only] Name of the resource.
Generated from protobuf field optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
clearName
setName
[Output Only] Name of the resource.
Generated from protobuf field optional string name = 3373707;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getScratchDisks
[Output Only] A list of extended scratch disks assigned to the instance.
Generated from protobuf field repeated .google.cloud.compute.v1.ScratchDisks scratch_disks = 480778481;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setScratchDisks
[Output Only] A list of extended scratch disks assigned to the instance.
Generated from protobuf field repeated .google.cloud.compute.v1.ScratchDisks scratch_disks = 480778481;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\ScratchDisks>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
string | |
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getZone
[Output Only] The name of the zone where the machine type resides, such as us-central1-a.
Generated from protobuf field optional string zone = 3744684;
| Returns | |
|---|---|
| Type | Description |
string | |
hasZone
clearZone
setZone
[Output Only] The name of the zone where the machine type resides, such as us-central1-a.
Generated from protobuf field optional string zone = 3744684;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |