Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

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

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

Namespace

Google \ Cloud \ BareMetalSolution \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Immutable. 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` Output only. 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` Immutable. The server type. Available server types
`↳ state`	`int` Output only. 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<Lun>` Immutable. List of LUNs associated with this server.
`↳ volumes`	`array<Volume>` Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.
`↳ networks`	`array<Network>` Output only. List of networks associated with this server.
`↳ interactive_serial_console_enabled`	`bool` Output only. 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<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.
`↳ login_info`	`string` Output only. Text field about info for logging in.
`↳ workload_profile`	`int` The workload profile for the instance.
`↳ firmware_version`	`string` Output only. The firmware version for the instance.

getName

Immutable. 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
Type	Description
`string`

setName

Immutable. 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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getId

Output only. An identifier for the Instance, generated by the backend.

Returns
Type	Description
`string`

setId

Output only. An identifier for the Instance, generated by the backend.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Create a time stamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create a time stamp.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Update a time stamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Update a time stamp.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getMachineType

Immutable. The server type.

Available server types

Returns
Type	Description
`string`

setMachineType

Immutable. The server type.

Available server types

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Output only. The state of the server.

Returns
Type	Description
`int`	Enum of type State.

setState

Output only. The state of the server.

Parameter
Name	Description
`var`	`int` Enum of type State.

Returns
Type	Description
`$this`

getHyperthreadingEnabled

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

The default value is false.

Returns
Type	Description
`bool`

setHyperthreadingEnabled

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

The default value is false.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getLabels

Labels as key value pairs.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Labels as key value pairs.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getLuns

Immutable. List of LUNs associated with this server.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setLuns

Immutable. List of LUNs associated with this server.

Parameter
Name	Description
`var`	`array<Lun>`

Returns
Type	Description
`$this`

getVolumes

Input only. List of Volumes to attach to this Instance on creation.

This field won't be populated in Get/List responses.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setVolumes

Input only. List of Volumes to attach to this Instance on creation.

This field won't be populated in Get/List responses.

Parameter
Name	Description
`var`	`array<Volume>`

Returns
Type	Description
`$this`

getNetworks

Output only. List of networks associated with this server.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setNetworks

Output only. List of networks associated with this server.

Parameter
Name	Description
`var`	`array<Network>`

Returns
Type	Description
`$this`

getInteractiveSerialConsoleEnabled

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

Returns
Type	Description
`bool`

setInteractiveSerialConsoleEnabled

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getOsImage

The OS image currently installed on the server.

Returns
Type	Description
`string`

setOsImage

The OS image currently installed on the server.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setLogicalInterfaces

Parameter
Name	Description
`var`	`array<LogicalInterface>`

Returns
Type	Description
`$this`

getLoginInfo

Output only. Text field about info for logging in.

Returns
Type	Description
`string`

setLoginInfo

Output only. Text field about info for logging in.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getWorkloadProfile

The workload profile for the instance.

Returns
Type	Description
`int`	Enum of type WorkloadProfile.

setWorkloadProfile

The workload profile for the instance.

Parameter
Name	Description
`var`	`int` Enum of type WorkloadProfile.

Returns
Type	Description
`$this`

getFirmwareVersion

Output only. The firmware version for the instance.

Returns
Type	Description
`string`

setFirmwareVersion

Output only. The firmware version for the instance.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`