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.



4466
4467
4468
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4466

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) 


4362
4363
4364
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4362

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


4367
4368
4369
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4367

def description
  @description
end

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

Returns:

  • (String) 


4374
4375
4376
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4374

def etag
  @etag
end

#field_paths_pending_update ⇒ Array<String>

Optional. The list of fields waiting for hub administrator's approval. Corresponds to the JSON property fieldPathsPendingUpdate

Returns:

  • (Array<String>) 


4379
4380
4381
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4379

def field_paths_pending_update
  @field_paths_pending_update
end

#group ⇒ String

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

Returns:

  • (String) 


4384
4385
4386
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4384

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) 


4389
4390
4391
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4389

def hub
  @hub
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


4396
4397
4398
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4396

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:



4404
4405
4406
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4404

def linked_interconnect_attachments
  @linked_interconnect_attachments
end

#linked_producer_vpc_network ⇒ Google::Apis::NetworkconnectivityV1::LinkedProducerVpcNetwork

Optional. The linked producer VPC that is associated with the spoke. Corresponds to the JSON property linkedProducerVpcNetwork

Returns:



4409
4410
4411
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4409

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



4417
4418
4419
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4417

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:



4422
4423
4424
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4422

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:



4430
4431
4432
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4430

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) 


4437
4438
4439
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4437

def name
  @name
end

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

Output only. The reasons for current state of the spoke. Corresponds to the JSON property reasons

Returns:



4442
4443
4444
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4442

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) 


4447
4448
4449
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4447

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) 


4452
4453
4454
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4452

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) 


4459
4460
4461
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4459

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) 


4464
4465
4466
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4464

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 4471

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @field_paths_pending_update = args[:field_paths_pending_update] if args.key?(:field_paths_pending_update)
  @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_producer_vpc_network = args[:linked_producer_vpc_network] if args.key?(:linked_producer_vpc_network)
  @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