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

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

A Network.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ id string

An identifier for the Network, generated by the backend.

↳ type int

The type of this network.

↳ ip_address string

IP address configured.

↳ mac_address array

List of physical interfaces.

↳ state int

The Network state.

↳ vlan_id string

The vlan id of the Network.

↳ cidr string

The cidr of the Network.

↳ vrf Google\Cloud\BareMetalSolution\V2\VRF

The vrf for the Network.

↳ labels array|Google\Protobuf\Internal\MapField

Labels as key value pairs.

↳ services_cidr string

IP range for reserved for services (e.g. NFS).

↳ reservations array<Google\Cloud\BareMetalSolution\V2\NetworkAddressReservation>

List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.

getName

Output only. The resource name of this Network.

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

Returns
TypeDescription
string

setName

Output only. The resource name of this Network.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

An identifier for the Network, generated by the backend.

Returns
TypeDescription
string

setId

An identifier for the Network, generated by the backend.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

The type of this network.

Returns
TypeDescription
int

setType

The type of this network.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getIpAddress

IP address configured.

Returns
TypeDescription
string

setIpAddress

IP address configured.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMacAddress

List of physical interfaces.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMacAddress

List of physical interfaces.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getState

The Network state.

Returns
TypeDescription
int

setState

The Network state.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getVlanId

The vlan id of the Network.

Returns
TypeDescription
string

setVlanId

The vlan id of the Network.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCidr

The cidr of the Network.

Returns
TypeDescription
string

setCidr

The cidr of the Network.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVrf

The vrf for the Network.

Returns
TypeDescription
Google\Cloud\BareMetalSolution\V2\VRF|null

hasVrf

clearVrf

setVrf

The vrf for the Network.

Parameter
NameDescription
var Google\Cloud\BareMetalSolution\V2\VRF
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

getServicesCidr

IP range for reserved for services (e.g. NFS).

Returns
TypeDescription
string

setServicesCidr

IP range for reserved for services (e.g. NFS).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReservations

List of IP address reservations in this network.

When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setReservations

List of IP address reservations in this network.

When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.

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