Class: Google::Apis::NetworkconnectivityV1::Route

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 route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Route

Returns a new instance of Route.



2720
2721
2722
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2720

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


2630
2631
2632
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2630

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


2635
2636
2637
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2635

def description
  @description
end

#ip_cidr_range ⇒ String

The destination IP address range. Corresponds to the JSON property ipCidrRange

Returns:

  • (String) 


2640
2641
2642
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2640

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


2647
2648
2649
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2647

def labels
  @labels
end

#location ⇒ String

Output only. The origin location of the route. Uses the following form: " projects/project/locations/location" Example: projects/1234/locations/us- central1 Corresponds to the JSON property location

Returns:

  • (String) 


2654
2655
2656
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2654

def location
  @location
end

#name ⇒ String

Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/project_number/locations/global/hubs/hub/ routeTables/route_table_id/routes/route_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


2661
2662
2663
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2661

def name
  @name
end

#next_hop_interconnect_attachment ⇒ Google::Apis::NetworkconnectivityV1::NextHopInterconnectAttachment

A route next hop that leads to an interconnect attachment resource. Corresponds to the JSON property nextHopInterconnectAttachment

Returns:



2666
2667
2668
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2666

def next_hop_interconnect_attachment
  @next_hop_interconnect_attachment
end

#next_hop_router_appliance_instance ⇒ Google::Apis::NetworkconnectivityV1::NextHopRouterApplianceInstance

A route next hop that leads to a Router appliance instance. Corresponds to the JSON property nextHopRouterApplianceInstance

Returns:



2671
2672
2673
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2671

def next_hop_router_appliance_instance
  @next_hop_router_appliance_instance
end

#next_hop_vpc_network ⇒ Google::Apis::NetworkconnectivityV1::NextHopVpcNetwork

Immutable. The destination VPC network for packets on this route. Corresponds to the JSON property nextHopVpcNetwork

Returns:



2676
2677
2678
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2676

def next_hop_vpc_network
  @next_hop_vpc_network
end

#next_hop_vpn_tunnel ⇒ Google::Apis::NetworkconnectivityV1::NextHopVpnTunnel

A route next hop that leads to a VPN tunnel resource. Corresponds to the JSON property nextHopVpnTunnel

Returns:



2681
2682
2683
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2681

def next_hop_vpn_tunnel
  @next_hop_vpn_tunnel
end

#priority ⇒ Fixnum

Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


2688
2689
2690
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2688

def priority
  @priority
end

#spoke ⇒ String

Immutable. The spoke that this route leads to. Example: projects/12345/ locations/global/spokes/SPOKE Corresponds to the JSON property spoke

Returns:

  • (String) 


2694
2695
2696
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2694

def spoke
  @spoke
end

#state ⇒ String

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

Returns:

  • (String) 


2699
2700
2701
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2699

def state
  @state
end

#type ⇒ String

Output only. The route's type. Its type is determined by the properties of its IP address range. Corresponds to the JSON property type

Returns:

  • (String) 


2705
2706
2707
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2705

def type
  @type
end

#uid ⇒ String

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

Returns:

  • (String) 


2713
2714
2715
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2713

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


2718
2719
2720
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2718

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2725

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
  @labels = args[:labels] if args.key?(:labels)
  @location = args[:location] if args.key?(:location)
  @name = args[:name] if args.key?(:name)
  @next_hop_interconnect_attachment = args[:next_hop_interconnect_attachment] if args.key?(:next_hop_interconnect_attachment)
  @next_hop_router_appliance_instance = args[:next_hop_router_appliance_instance] if args.key?(:next_hop_router_appliance_instance)
  @next_hop_vpc_network = args[:next_hop_vpc_network] if args.key?(:next_hop_vpc_network)
  @next_hop_vpn_tunnel = args[:next_hop_vpn_tunnel] if args.key?(:next_hop_vpn_tunnel)
  @priority = args[:priority] if args.key?(:priority)
  @spoke = args[:spoke] if args.key?(:spoke)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end