Google Cloud Network Connectivity V1 Client - Class Spoke (1.0.5)

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class Spoke.

A Network Connectivity Center spoke represents a connection between your Google Cloud network resources and a non-Google-Cloud network.

When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields:

  • linked_vpn_tunnels
  • linked_interconnect_attachments
  • linked_router_appliance_instances

Generated from protobuf message google.cloud.networkconnectivity.v1.Spoke

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}

↳ create_time Google\Protobuf\Timestamp

Output only. The time the spoke was created.

↳ update_time Google\Protobuf\Timestamp

Output only. The time the spoke was last updated.

↳ labels array|Google\Protobuf\Internal\MapField

Optional labels in key:value format. For more information about labels, see Requirements for labels.

↳ description string

An optional description of the spoke.

↳ hub string

Immutable. The name of the hub that this spoke is attached to.

↳ linked_vpn_tunnels Google\Cloud\NetworkConnectivity\V1\LinkedVpnTunnels

VPN tunnels that are associated with the spoke.

↳ linked_interconnect_attachments Google\Cloud\NetworkConnectivity\V1\LinkedInterconnectAttachments

VLAN attachments that are associated with the spoke.

↳ linked_router_appliance_instances Google\Cloud\NetworkConnectivity\V1\LinkedRouterApplianceInstances

Router appliance instances that are associated with the spoke.

↳ unique_id string

Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.

↳ state int

Output only. The current lifecycle state of this spoke.

getName

Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}

Returns
TypeDescription
string

setName

Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The time the spoke was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the spoke was created.

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

getUpdateTime

Output only. The time the spoke was last updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the spoke was last updated.

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

getLabels

Optional labels in key:value format. For more information about labels, see Requirements for labels.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional labels in key:value format. For more information about labels, see Requirements for labels.

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

getDescription

An optional description of the spoke.

Returns
TypeDescription
string

setDescription

An optional description of the spoke.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHub

Immutable. The name of the hub that this spoke is attached to.

Returns
TypeDescription
string

setHub

Immutable. The name of the hub that this spoke is attached to.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLinkedVpnTunnels

VPN tunnels that are associated with the spoke.

Returns
TypeDescription
Google\Cloud\NetworkConnectivity\V1\LinkedVpnTunnels|null

hasLinkedVpnTunnels

clearLinkedVpnTunnels

setLinkedVpnTunnels

VPN tunnels that are associated with the spoke.

Parameter
NameDescription
var Google\Cloud\NetworkConnectivity\V1\LinkedVpnTunnels
Returns
TypeDescription
$this

getLinkedInterconnectAttachments

VLAN attachments that are associated with the spoke.

Returns
TypeDescription
Google\Cloud\NetworkConnectivity\V1\LinkedInterconnectAttachments|null

hasLinkedInterconnectAttachments

clearLinkedInterconnectAttachments

setLinkedInterconnectAttachments

VLAN attachments that are associated with the spoke.

Parameter
NameDescription
var Google\Cloud\NetworkConnectivity\V1\LinkedInterconnectAttachments
Returns
TypeDescription
$this

getLinkedRouterApplianceInstances

Router appliance instances that are associated with the spoke.

Returns
TypeDescription
Google\Cloud\NetworkConnectivity\V1\LinkedRouterApplianceInstances|null

hasLinkedRouterApplianceInstances

clearLinkedRouterApplianceInstances

setLinkedRouterApplianceInstances

Router appliance instances that are associated with the spoke.

Parameter
NameDescription
var Google\Cloud\NetworkConnectivity\V1\LinkedRouterApplianceInstances
Returns
TypeDescription
$this

getUniqueId

Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.

Returns
TypeDescription
string

setUniqueId

Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The current lifecycle state of this spoke.

Returns
TypeDescription
int

setState

Output only. The current lifecycle state of this spoke.

Parameter
NameDescription
var int
Returns
TypeDescription
$this