Reference documentation and code samples for the Google Cloud Vm Migration V1 Client class ComputeEngineTargetDefaults.
ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project.
Generated from protobuf message google.cloud.vmmigration.v1.ComputeEngineTargetDefaults
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ vm_name |
string
The name of the VM to create. |
↳ target_project |
string
The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. |
↳ zone |
string
The zone in which to create the VM. |
↳ machine_type_series |
string
The machine type series to create the VM with. |
↳ machine_type |
string
The machine type to create the VM with. |
↳ network_tags |
array
A map of network tags to associate with the VM. |
↳ network_interfaces |
array<Google\Cloud\VMMigration\V1\NetworkInterface>
List of NICs connected to this VM. |
↳ service_account |
string
The service account to associate the VM with. |
↳ disk_type |
int
The disk type to use in the VM. |
↳ labels |
array|Google\Protobuf\Internal\MapField
A map of labels to associate with the VM. |
↳ license_type |
int
The license type to use in OS adaptation. |
↳ applied_license |
Google\Cloud\VMMigration\V1\AppliedLicense
Output only. The OS license returned from the adaptation module report. |
↳ compute_scheduling |
Google\Cloud\VMMigration\V1\ComputeScheduling
Compute instance scheduling information (if empty default is used). |
↳ secure_boot |
bool
Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI. |
↳ boot_option |
int
Output only. The VM Boot Option, as set in the source vm. |
↳ metadata |
array|Google\Protobuf\Internal\MapField
The metadata key/value pairs to assign to the VM. |
↳ additional_licenses |
array
Additional licenses to assign to the VM. |
↳ hostname |
string
The hostname to assign to the VM. |
getVmName
The name of the VM to create.
| Returns | |
|---|---|
| Type | Description |
string | |
setVmName
The name of the VM to create.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetProject
The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
| Returns | |
|---|---|
| Type | Description |
string | |
setTargetProject
The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getZone
The zone in which to create the VM.
| Returns | |
|---|---|
| Type | Description |
string | |
setZone
The zone in which to create the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMachineTypeSeries
The machine type series to create the VM with.
| Returns | |
|---|---|
| Type | Description |
string | |
setMachineTypeSeries
The machine type series to create the VM with.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMachineType
The machine type to create the VM with.
| Returns | |
|---|---|
| Type | Description |
string | |
setMachineType
The machine type to create the VM with.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetworkTags
A map of network tags to associate with the VM.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setNetworkTags
A map of network tags to associate with the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetworkInterfaces
List of NICs connected to this VM.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setNetworkInterfaces
List of NICs connected to this VM.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\VMMigration\V1\NetworkInterface>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServiceAccount
The service account to associate the VM with.
| Returns | |
|---|---|
| Type | Description |
string | |
setServiceAccount
The service account to associate the VM with.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiskType
The disk type to use in the VM.
| Returns | |
|---|---|
| Type | Description |
int | |
setDiskType
The disk type to use in the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
A map of labels to associate with the VM.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
A map of labels to associate with the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLicenseType
The license type to use in OS adaptation.
| Returns | |
|---|---|
| Type | Description |
int | |
setLicenseType
The license type to use in OS adaptation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAppliedLicense
Output only. The OS license returned from the adaptation module report.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VMMigration\V1\AppliedLicense|null | |
hasAppliedLicense
clearAppliedLicense
setAppliedLicense
Output only. The OS license returned from the adaptation module report.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VMMigration\V1\AppliedLicense
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getComputeScheduling
Compute instance scheduling information (if empty default is used).
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VMMigration\V1\ComputeScheduling|null | |
hasComputeScheduling
clearComputeScheduling
setComputeScheduling
Compute instance scheduling information (if empty default is used).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\VMMigration\V1\ComputeScheduling
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSecureBoot
Defines whether the instance has Secure Boot enabled.
This can be set to true only if the vm boot option is EFI.
| Returns | |
|---|---|
| Type | Description |
bool | |
setSecureBoot
Defines whether the instance has Secure Boot enabled.
This can be set to true only if the vm boot option is EFI.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBootOption
Output only. The VM Boot Option, as set in the source vm.
| Returns | |
|---|---|
| Type | Description |
int | |
setBootOption
Output only. The VM Boot Option, as set in the source vm.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetadata
The metadata key/value pairs to assign to the VM.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setMetadata
The metadata key/value pairs to assign to the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAdditionalLicenses
Additional licenses to assign to the VM.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAdditionalLicenses
Additional licenses to assign to the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHostname
The hostname to assign to the VM.
| Returns | |
|---|---|
| Type | Description |
string | |
setHostname
The hostname to assign to the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |