Class: Google::Apis::NetworkconnectivityV1::Hub

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 hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Hub

Returns a new instance of Hub.



611
612
613
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 611

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


551
552
553
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 551

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


556
557
558
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 556

def description
  @description
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>) 


563
564
565
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 563

def labels
  @labels
end

#name ⇒ String

Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/project_number/locations/global/hubs/hub_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


569
570
571
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 569

def name
  @name
end

#route_tables ⇒ Array<String>

Output only. The route tables that belong to this hub. They use the following form: projects/project_number/locations/global/hubs/hub_id/routeTables/ route_table_id`This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub. Corresponds to the JSON propertyrouteTables`

Returns:

  • (Array<String>) 


577
578
579
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 577

def route_tables
  @route_tables
end

#routing_vpcs ⇒ Array<Google::Apis::NetworkconnectivityV1::RoutingVpc>

The VPC networks associated with this hub's spokes. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub. Corresponds to the JSON property routingVpcs

Returns:



584
585
586
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 584

def routing_vpcs
  @routing_vpcs
end

#spoke_summary ⇒ Google::Apis::NetworkconnectivityV1::SpokeSummary

Summarizes information about the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason. Corresponds to the JSON property spokeSummary

Returns:



592
593
594
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 592

def spoke_summary
  @spoke_summary
end

#state ⇒ String

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

Returns:

  • (String) 


597
598
599
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 597

def state
  @state
end

#unique_id ⇒ String

Output only. The Google-generated UUID for the hub. This value is unique across all hub resources. If a hub is deleted and another with the same name is created, the new hub is assigned a different unique_id. Corresponds to the JSON property uniqueId

Returns:

  • (String) 


604
605
606
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 604

def unique_id
  @unique_id
end

#update_time ⇒ String

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

Returns:

  • (String) 


609
610
611
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 609

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 616

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @route_tables = args[:route_tables] if args.key?(:route_tables)
  @routing_vpcs = args[:routing_vpcs] if args.key?(:routing_vpcs)
  @spoke_summary = args[:spoke_summary] if args.key?(:spoke_summary)
  @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