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 \ V1Methods
__construct
Constructor.
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
↳ update_time
↳ 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}
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}
var
string
$this
getCreateTime
Output only. The time the spoke was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the spoke was created.
$this
getUpdateTime
Output only. The time the spoke was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the spoke was last updated.
$this
getLabels
Optional labels in key-value pair format. For more information about labels, see Requirements for labels .
setLabels
Optional labels in key-value pair format. For more information about labels, see Requirements for labels .
$this
getDescription
An optional description of the spoke.
string
setDescription
An optional description of the spoke.
var
string
$this
getHub
Immutable. The name of the hub that this spoke is attached to.
string
setHub
Immutable. The name of the hub that this spoke is attached to.
var
string
$this
getGroup
Optional. The name of the group that this spoke is associated with.
string
setGroup
Optional. The name of the group that this spoke is associated with.
var
string
$this
getLinkedVpnTunnels
VPN tunnels that are associated with the spoke.
hasLinkedVpnTunnels
clearLinkedVpnTunnels
setLinkedVpnTunnels
VPN tunnels that are associated with the spoke.
$this
getLinkedInterconnectAttachments
VLAN attachments that are associated with the spoke.
hasLinkedInterconnectAttachments
clearLinkedInterconnectAttachments
setLinkedInterconnectAttachments
VLAN attachments that are associated with the spoke.
$this
getLinkedRouterApplianceInstances
Router appliance instances that are associated with the spoke.
hasLinkedRouterApplianceInstances
clearLinkedRouterApplianceInstances
setLinkedRouterApplianceInstances
Router appliance instances that are associated with the spoke.
$this
getLinkedVpcNetwork
Optional. VPC network that is associated with the spoke.
hasLinkedVpcNetwork
clearLinkedVpcNetwork
setLinkedVpcNetwork
Optional. VPC network that is associated with the spoke.
$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
.
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
.
var
string
$this
getState
Output only. The current lifecycle state of this spoke.
int
setState
Output only. The current lifecycle state of this spoke.
var
int
$this
getReasons
Output only. The reasons for current state of the spoke. Only present when
the spoke is in the INACTIVE
state.
setReasons
Output only. The reasons for current state of the spoke. Only present when
the spoke is in the INACTIVE
state.
$this
getSpokeType
Output only. The type of resource associated with the spoke.
int
setSpokeType
Output only. The type of resource associated with the spoke.
var
int
$this
