Network Connectivity V1 API - Class Google::Cloud::NetworkConnectivity::V1::Spoke (v1.1.0)

Version 1.1.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 0.10.0
• 0.9.2
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.4

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

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time the spoke was created.

#description

def description() -> ::String

Returns

• (::String) — An optional description of the spoke.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — An optional description of the spoke.

Returns

• (::String) — An optional description of the spoke.

#group

def group() -> ::String

Returns

• (::String) — Optional. The name of the group that this spoke is associated with.

#group=

def group=(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

def hub() -> ::String

Returns

• (::String) — Immutable. The name of the hub that this spoke is attached to.

#hub=

def hub=(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

def labels() -> ::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=

def labels=(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

def linked_interconnect_attachments() -> ::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments

Returns

• (::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments) — VLAN attachments that are associated with the spoke.

#linked_interconnect_attachments=

def linked_interconnect_attachments=(value) -> ::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments

Parameter

• value (::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments) — VLAN attachments that are associated with the spoke.

Returns

• (::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments) — VLAN attachments that are associated with the spoke.

#linked_producer_vpc_network

def linked_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=

def linked_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

def linked_router_appliance_instances() -> ::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances

Returns

• (::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances) — Router appliance instances that are associated with the spoke.

#linked_router_appliance_instances=

def linked_router_appliance_instances=(value) -> ::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances

Parameter

• value (::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances) — Router appliance instances that are associated with the spoke.

Returns

• (::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances) — Router appliance instances that are associated with the spoke.

#linked_vpc_network

def linked_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=

def linked_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

def linked_vpn_tunnels() -> ::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels

Returns

• (::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels) — VPN tunnels that are associated with the spoke.

#linked_vpn_tunnels=

def linked_vpn_tunnels=(value) -> ::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels

Parameter

• value (::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels) — VPN tunnels that are associated with the spoke.

Returns

• (::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels) — VPN tunnels that are associated with the spoke.

#name

def name() -> ::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=

def name=(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

def reasons() -> ::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. Only present when the spoke is in the INACTIVE state.

#spoke_type

def spoke_type() -> ::Google::Cloud::NetworkConnectivity::V1::SpokeType

Returns

• (::Google::Cloud::NetworkConnectivity::V1::SpokeType) — Output only. The type of resource associated with the spoke.

#state

def state() -> ::Google::Cloud::NetworkConnectivity::V1::State

Returns

• (::Google::Cloud::NetworkConnectivity::V1::State) — Output only. The current lifecycle state of this spoke.

#unique_id

def unique_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

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time the spoke was last updated.