Google Cloud Bare Metal Solution V2 Client - Class InstanceConfig (0.5.2)

Reference documentation and code samples for the Google Cloud Bare Metal Solution V2 Client class InstanceConfig.

Configuration parameters for a new instance.

Generated from protobuf message google.cloud.baremetalsolution.v2.InstanceConfig

Namespace

Google \ Cloud \ BareMetalSolution \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The name of the instance config.

↳ id string

A transient unique identifier to idenfity an instance within an ProvisioningConfig request.

↳ instance_type string

Instance type. Available types

↳ hyperthreading bool

Whether the instance should be provisioned with Hyperthreading enabled.

↳ os_image string

OS image to initialize the instance. Available images

↳ client_network Google\Cloud\BareMetalSolution\V2\InstanceConfig\NetworkAddress

Client network address. Filled if InstanceConfig.multivlan_config is false.

↳ private_network Google\Cloud\BareMetalSolution\V2\InstanceConfig\NetworkAddress

Private network address, if any. Filled if InstanceConfig.multivlan_config is false.

↳ user_note string

User note field, it can be used by customers to add additional information for the BMS Ops team .

↳ account_networks_enabled bool

If true networks can be from different projects of the same vendor account.

↳ network_config int

The type of network configuration on the instance.

↳ network_template string

Server network template name. Filled if InstanceConfig.multivlan_config is true.

↳ logical_interfaces array<Google\Cloud\BareMetalSolution\V2\LogicalInterface>

List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.

↳ ssh_key_names array

List of names of ssh keys used to provision the instance.

getName

Output only. The name of the instance config.

Returns
TypeDescription
string

setName

Output only. The name of the instance config.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

A transient unique identifier to idenfity an instance within an ProvisioningConfig request.

Returns
TypeDescription
string

setId

A transient unique identifier to idenfity an instance within an ProvisioningConfig request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstanceType

Instance type.

Available types

Returns
TypeDescription
string

setInstanceType

Instance type.

Available types

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHyperthreading

Whether the instance should be provisioned with Hyperthreading enabled.

Returns
TypeDescription
bool

setHyperthreading

Whether the instance should be provisioned with Hyperthreading enabled.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getOsImage

OS image to initialize the instance.

Available images

Returns
TypeDescription
string

setOsImage

OS image to initialize the instance.

Available images

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClientNetwork

Client network address. Filled if InstanceConfig.multivlan_config is false.

Returns
TypeDescription
Google\Cloud\BareMetalSolution\V2\InstanceConfig\NetworkAddress|null

hasClientNetwork

clearClientNetwork

setClientNetwork

Client network address. Filled if InstanceConfig.multivlan_config is false.

Parameter
NameDescription
var Google\Cloud\BareMetalSolution\V2\InstanceConfig\NetworkAddress
Returns
TypeDescription
$this

getPrivateNetwork

Private network address, if any. Filled if InstanceConfig.multivlan_config is false.

Returns
TypeDescription
Google\Cloud\BareMetalSolution\V2\InstanceConfig\NetworkAddress|null

hasPrivateNetwork

clearPrivateNetwork

setPrivateNetwork

Private network address, if any. Filled if InstanceConfig.multivlan_config is false.

Parameter
NameDescription
var Google\Cloud\BareMetalSolution\V2\InstanceConfig\NetworkAddress
Returns
TypeDescription
$this

getUserNote

User note field, it can be used by customers to add additional information for the BMS Ops team .

Returns
TypeDescription
string

setUserNote

User note field, it can be used by customers to add additional information for the BMS Ops team .

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAccountNetworksEnabled

If true networks can be from different projects of the same vendor account.

Returns
TypeDescription
bool

setAccountNetworksEnabled

If true networks can be from different projects of the same vendor account.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getNetworkConfig

The type of network configuration on the instance.

Returns
TypeDescription
int

setNetworkConfig

The type of network configuration on the instance.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getNetworkTemplate

Server network template name. Filled if InstanceConfig.multivlan_config is true.

Returns
TypeDescription
string

setNetworkTemplate

Server network template name. Filled if InstanceConfig.multivlan_config is true.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLogicalInterfaces

List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setLogicalInterfaces

List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.

Parameter
NameDescription
var array<Google\Cloud\BareMetalSolution\V2\LogicalInterface>
Returns
TypeDescription
$this

getSshKeyNames

List of names of ssh keys used to provision the instance.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSshKeyNames

List of names of ssh keys used to provision the instance.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this