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

Version 1.5.0

• 1.5.5 (latest)
• 1.5.4
• 1.4.2
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.5

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

A Network Connectivity Center spoke represents one or more network connectivity resources.

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
• linked_vpc_network

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

Namespace

Google \ Cloud \ NetworkConnectivity \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
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 pair 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.
↳ group	string Optional. The name of the group that this spoke is associated with.
↳ 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.
↳ linked_vpc_network	Google\Cloud\NetworkConnectivity\V1\LinkedVpcNetwork Optional. VPC network that is 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.
↳ reasons	array<Google\Cloud\NetworkConnectivity\V1\Spoke\StateReason> Output only. The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.
↳ spoke_type	int Output only. The type of resource associated with the 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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. The time the spoke was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the spoke was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The time the spoke was last updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the spoke was last updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLabels

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

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

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

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

Returns
Type	Description
$this

getDescription

An optional description of the spoke.

Returns
Type	Description
string

setDescription

An optional description of the spoke.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getHub

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

Returns
Type	Description
string

setHub

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getGroup

Optional. The name of the group that this spoke is associated with.

Returns
Type	Description
string

setGroup

Optional. The name of the group that this spoke is associated with.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLinkedVpnTunnels

VPN tunnels that are associated with the spoke.

Returns
Type	Description
Google\Cloud\NetworkConnectivity\V1\LinkedVpnTunnels|null

hasLinkedVpnTunnels

clearLinkedVpnTunnels

setLinkedVpnTunnels

VPN tunnels that are associated with the spoke.

Parameter
Name	Description
var	Google\Cloud\NetworkConnectivity\V1\LinkedVpnTunnels

Returns
Type	Description
$this

getLinkedInterconnectAttachments

VLAN attachments that are associated with the spoke.

Returns
Type	Description
Google\Cloud\NetworkConnectivity\V1\LinkedInterconnectAttachments|null

hasLinkedInterconnectAttachments

clearLinkedInterconnectAttachments

setLinkedInterconnectAttachments

VLAN attachments that are associated with the spoke.

Parameter
Name	Description
var	Google\Cloud\NetworkConnectivity\V1\LinkedInterconnectAttachments

Returns
Type	Description
$this

getLinkedRouterApplianceInstances

Router appliance instances that are associated with the spoke.

Returns
Type	Description
Google\Cloud\NetworkConnectivity\V1\LinkedRouterApplianceInstances|null

hasLinkedRouterApplianceInstances

clearLinkedRouterApplianceInstances

setLinkedRouterApplianceInstances

Router appliance instances that are associated with the spoke.

Parameter
Name	Description
var	Google\Cloud\NetworkConnectivity\V1\LinkedRouterApplianceInstances

Returns
Type	Description
$this

getLinkedVpcNetwork

Optional. VPC network that is associated with the spoke.

Returns
Type	Description
Google\Cloud\NetworkConnectivity\V1\LinkedVpcNetwork|null

hasLinkedVpcNetwork

clearLinkedVpcNetwork

setLinkedVpcNetwork

Optional. VPC network that is associated with the spoke.

Parameter
Name	Description
var	Google\Cloud\NetworkConnectivity\V1\LinkedVpcNetwork

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

Returns
Type	Description
$this

getState

Output only. The current lifecycle state of this spoke.

Returns
Type	Description
int

setState

Output only. The current lifecycle state of this spoke.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getReasons

Output only. The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setReasons

Output only. The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.

Parameter
Name	Description
var	array<Google\Cloud\NetworkConnectivity\V1\Spoke\StateReason>

Returns
Type	Description
$this

getSpokeType

Output only. The type of resource associated with the spoke.

Returns
Type	Description
int

setSpokeType

Output only. The type of resource associated with the spoke.

Parameter
Name	Description
var	int

Returns
Type	Description
$this