Network Connectivity V1 API - Class Google::Cloud::NetworkConnectivity::V1::Spoke (v1.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Network Connectivity V1 API class Google::Cloud::NetworkConnectivity::V1::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
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
defcreate_time()->::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the spoke was created.
#description
defdescription()->::String
Returns
- (::String) — Optional. An optional description of the spoke.
#description=
defdescription=(value)->::String
Parameter
- value (::String) — Optional. An optional description of the spoke.
Returns
- (::String) — Optional. An optional description of the spoke.
#etag
defetag()->::String
Returns
- (::String) — Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
#etag=
defetag=(value)->::String
Parameter
- value (::String) — Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Returns
- (::String) — Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
#field_paths_pending_update
deffield_paths_pending_update()->::Array<::String>
Returns
- (::Array<::String>) — Optional. The list of fields waiting for hub administration's approval.
#field_paths_pending_update=
deffield_paths_pending_update=(value)->::Array<::String>
Parameter
- value (::Array<::String>) — Optional. The list of fields waiting for hub administration's approval.
Returns
- (::Array<::String>) — Optional. The list of fields waiting for hub administration's approval.
#group
defgroup()->::String
Returns
- (::String) — Optional. The name of the group that this spoke is associated with.
#group=
defgroup=(value)->::String
Parameter
- value (::String) — Optional. The name of the group that this spoke is associated with.
Returns
- (::String) — Optional. The name of the group that this spoke is associated with.
#hub
defhub()->::String
Returns
- (::String) — Immutable. The name of the hub that this spoke is attached to.
#hub=
defhub=(value)->::String
Parameter
- value (::String) — Immutable. The name of the hub that this spoke is attached to.
Returns
- (::String) — Immutable. The name of the hub that this spoke is attached to.
#labels
deflabels()->::Google::Protobuf::Map{::String=>::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
#labels=
deflabels=(value)->::Google::Protobuf::Map{::String=>::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
#linked_interconnect_attachments
deflinked_interconnect_attachments()->::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments) — Optional. VLAN attachments that are associated with the spoke.
#linked_interconnect_attachments=
deflinked_interconnect_attachments=(value)->::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments
Parameter
- value (::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments) — Optional. VLAN attachments that are associated with the spoke.
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments) — Optional. VLAN attachments that are associated with the spoke.
#linked_producer_vpc_network
deflinked_producer_vpc_network()->::Google::Cloud::NetworkConnectivity::V1::LinkedProducerVpcNetwork
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedProducerVpcNetwork) — Optional. The linked producer VPC that is associated with the spoke.
#linked_producer_vpc_network=
deflinked_producer_vpc_network=(value)->::Google::Cloud::NetworkConnectivity::V1::LinkedProducerVpcNetwork
Parameter
- value (::Google::Cloud::NetworkConnectivity::V1::LinkedProducerVpcNetwork) — Optional. The linked producer VPC that is associated with the spoke.
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedProducerVpcNetwork) — Optional. The linked producer VPC that is associated with the spoke.
#linked_router_appliance_instances
deflinked_router_appliance_instances()->::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances) — Optional. Router appliance instances that are associated with the spoke.
#linked_router_appliance_instances=
deflinked_router_appliance_instances=(value)->::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances
Parameter
- value (::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances) — Optional. Router appliance instances that are associated with the spoke.
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances) — Optional. Router appliance instances that are associated with the spoke.
#linked_vpc_network
deflinked_vpc_network()->::Google::Cloud::NetworkConnectivity::V1::LinkedVpcNetwork
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedVpcNetwork) — Optional. VPC network that is associated with the spoke.
#linked_vpc_network=
deflinked_vpc_network=(value)->::Google::Cloud::NetworkConnectivity::V1::LinkedVpcNetwork
Parameter
- value (::Google::Cloud::NetworkConnectivity::V1::LinkedVpcNetwork) — Optional. VPC network that is associated with the spoke.
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedVpcNetwork) — Optional. VPC network that is associated with the spoke.
#linked_vpn_tunnels
deflinked_vpn_tunnels()->::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels) — Optional. VPN tunnels that are associated with the spoke.
#linked_vpn_tunnels=
deflinked_vpn_tunnels=(value)->::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels
Parameter
- value (::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels) — Optional. VPN tunnels that are associated with the spoke.
Returns
- (::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels) — Optional. VPN tunnels that are associated with the spoke.
#name
defname()->::String
Returns
-
(::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}
#name=
defname=(value)->::String
Parameter
-
value (::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}
Returns
-
(::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}
#reasons
defreasons()->::Array<::Google::Cloud::NetworkConnectivity::V1::Spoke::StateReason>
Returns
- (::Array<::Google::Cloud::NetworkConnectivity::V1::Spoke::StateReason>) — Output only. The reasons for current state of the spoke.
#spoke_type
defspoke_type()->::Google::Cloud::NetworkConnectivity::V1::SpokeType
Returns
- (::Google::Cloud::NetworkConnectivity::V1::SpokeType) — Output only. The type of resource associated with the spoke.
#state
defstate()->::Google::Cloud::NetworkConnectivity::V1::State
Returns
- (::Google::Cloud::NetworkConnectivity::V1::State) — Output only. The current lifecycle state of this spoke.
#unique_id
defunique_id()->::String
Returns
-
(::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.
#update_time
defupdate_time()->::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the spoke was last updated.