Class: Google::Apis::NetworkconnectivityV1::Spoke

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/networkconnectivity_v1/classes.rb,
lib/google/apis/networkconnectivity_v1/representations.rb,
lib/google/apis/networkconnectivity_v1/representations.rb

Overview

A 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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Spoke

Returns a new instance of Spoke.



1009
1010
1011
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1009

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. The time the spoke was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


943
944
945
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 943

def create_time
  @create_time
end

#description ⇒ String

An optional description of the spoke. Corresponds to the JSON property description

Returns:

  • (String) 


948
949
950
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 948

def description
  @description
end

#hub ⇒ String

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

Returns:

  • (String) 


953
954
955
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 953

def hub
  @hub
end

#labels ⇒ Hash<String,String>

Optional labels in key:value format. For more information about labels, see Requirements for labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


960
961
962
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 960

def labels
  @labels
end

#linked_interconnect_attachments ⇒ Google::Apis::NetworkconnectivityV1::LinkedInterconnectAttachments

A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. Corresponds to the JSON property linkedInterconnectAttachments

Returns:



968
969
970
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 968

def linked_interconnect_attachments
  @linked_interconnect_attachments
end

#linked_router_appliance_instances ⇒ Google::Apis::NetworkconnectivityV1::LinkedRouterApplianceInstances

A collection of router appliance instances. If you have multiple router appliance instances connected to the same site, they should all be attached to the same spoke. Corresponds to the JSON property linkedRouterApplianceInstances

Returns:



975
976
977
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 975

def linked_router_appliance_instances
  @linked_router_appliance_instances
end

#linked_vpn_tunnels ⇒ Google::Apis::NetworkconnectivityV1::LinkedVpnTunnels

A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. Corresponds to the JSON property linkedVpnTunnels

Returns:



983
984
985
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 983

def linked_vpn_tunnels
  @linked_vpn_tunnels
end

#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 Corresponds to the JSON property name

Returns:

  • (String) 


990
991
992
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 990

def name
  @name
end

#state ⇒ String

Output only. The current lifecycle state of this spoke. Corresponds to the JSON property state

Returns:

  • (String) 


995
996
997
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 995

def state
  @state
end

#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. Corresponds to the JSON property uniqueId

Returns:

  • (String) 


1002
1003
1004
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1002

def unique_id
  @unique_id
end

#update_time ⇒ String

Output only. The time the spoke was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1007
1008
1009
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1007

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 1014

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @hub = args[:hub] if args.key?(:hub)
  @labels = args[:labels] if args.key?(:labels)
  @linked_interconnect_attachments = args[:linked_interconnect_attachments] if args.key?(:linked_interconnect_attachments)
  @linked_router_appliance_instances = args[:linked_router_appliance_instances] if args.key?(:linked_router_appliance_instances)
  @linked_vpn_tunnels = args[:linked_vpn_tunnels] if args.key?(:linked_vpn_tunnels)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @unique_id = args[:unique_id] if args.key?(:unique_id)
  @update_time = args[:update_time] if args.key?(:update_time)
end