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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Spoke

Returns a new instance of Spoke.



2481
2482
2483
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2481

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) 


2393
2394
2395
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2393

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


2398
2399
2400
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2398

def description
  @description
end

#group ⇒ String

The name of the group that this spoke is associated with. Corresponds to the JSON property group

Returns:

  • (String) 


2403
2404
2405
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2403

def group
  @group
end

#hub ⇒ String

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

Returns:

  • (String) 


2408
2409
2410
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2408

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>) 


2415
2416
2417
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2415

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:



2423
2424
2425
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2423

def linked_interconnect_attachments
  @linked_interconnect_attachments
end

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

A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. Corresponds to the JSON property linkedRouterApplianceInstances

Returns:



2431
2432
2433
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2431

def linked_router_appliance_instances
  @linked_router_appliance_instances
end

#linked_vpc_network ⇒ Google::Apis::NetworkconnectivityV1::LinkedVpcNetwork

An existing VPC network. Corresponds to the JSON property linkedVpcNetwork

Returns:



2436
2437
2438
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2436

def linked_vpc_network
  @linked_vpc_network
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:



2444
2445
2446
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2444

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) 


2451
2452
2453
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2451

def name
  @name
end

#reasons ⇒ Array<Google::Apis::NetworkconnectivityV1::StateReason>

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

Returns:



2457
2458
2459
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2457

def reasons
  @reasons
end

#spoke_type ⇒ String

Output only. The type of resource associated with the spoke. Corresponds to the JSON property spokeType

Returns:

  • (String) 


2462
2463
2464
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2462

def spoke_type
  @spoke_type
end

#state ⇒ String

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

Returns:

  • (String) 


2467
2468
2469
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2467

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) 


2474
2475
2476
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2474

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) 


2479
2480
2481
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2479

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2486

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @group = args[:group] if args.key?(:group)
  @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_vpc_network = args[:linked_vpc_network] if args.key?(:linked_vpc_network)
  @linked_vpn_tunnels = args[:linked_vpn_tunnels] if args.key?(:linked_vpn_tunnels)
  @name = args[:name] if args.key?(:name)
  @reasons = args[:reasons] if args.key?(:reasons)
  @spoke_type = args[:spoke_type] if args.key?(:spoke_type)
  @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