Google Cloud Bare Metal Solution V2 Client - Class Instance (0.2.8)

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

A server.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of this Instance. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/instances/{instance}

↳ id string

An identifier for the Instance, generated by the backend.

↳ create_time Google\Protobuf\Timestamp

Output only. Create a time stamp.

↳ update_time Google\Protobuf\Timestamp

Output only. Update a time stamp.

↳ machine_type string

The server type. Available server types

↳ state int

The state of the server.

↳ hyperthreading_enabled bool

True if you enable hyperthreading for the server, otherwise false. The default value is false.

↳ labels array|Google\Protobuf\Internal\MapField

Labels as key value pairs.

↳ luns array<Google\Cloud\BareMetalSolution\V2\Lun>

List of LUNs associated with this server.

↳ networks array<Google\Cloud\BareMetalSolution\V2\Network>

List of networks associated with this server.

↳ interactive_serial_console_enabled bool

True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.

↳ os_image string

The OS image currently installed on the server.

↳ pod string

Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.

↳ network_template string

Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond<bond_mode>" or "nic".

↳ 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. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.

getName

Output only. The resource name of this Instance.

Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/instances/{instance}

Returns
TypeDescription
string

setName

Output only. The resource name of this Instance.

Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/instances/{instance}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

An identifier for the Instance, generated by the backend.

Returns
TypeDescription
string

setId

An identifier for the Instance, generated by the backend.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Create a time stamp.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create a time stamp.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Update a time stamp.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Update a time stamp.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getMachineType

The server type.

Available server types

Returns
TypeDescription
string

setMachineType

The server type.

Available server types

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

The state of the server.

Returns
TypeDescription
int

setState

The state of the server.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getHyperthreadingEnabled

True if you enable hyperthreading for the server, otherwise false.

The default value is false.

Returns
TypeDescription
bool

setHyperthreadingEnabled

True if you enable hyperthreading for the server, otherwise false.

The default value is false.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getLabels

Labels as key value pairs.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Labels as key value pairs.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getLuns

List of LUNs associated with this server.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setLuns

List of LUNs associated with this server.

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

getNetworks

List of networks associated with this server.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNetworks

List of networks associated with this server.

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

getInteractiveSerialConsoleEnabled

True if the interactive serial console feature is enabled for the instance, false otherwise.

The default value is false.

Returns
TypeDescription
bool

setInteractiveSerialConsoleEnabled

True if the interactive serial console feature is enabled for the instance, false otherwise.

The default value is false.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getOsImage

The OS image currently installed on the server.

Returns
TypeDescription
string

setOsImage

The OS image currently installed on the server.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPod

Immutable. Pod name.

Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.

Returns
TypeDescription
string

setPod

Immutable. Pod name.

Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNetworkTemplate

Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc.

Generally, the template name follows the syntax of "bond<bond_mode>" or "nic".

Returns
TypeDescription
string

setNetworkTemplate

Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc.

Generally, the template name follows the syntax of "bond<bond_mode>" or "nic".

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. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.

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. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.

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