Class: Google::Apis::ComputeAlpha::Route

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

Overview

Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read theRoutes overview.

Defined Under Namespace

Classes: Warning

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Route

Returns a new instance of Route.



64707
64708
64709
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64707

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

Instance Attribute Details

#allow_conflicting_subnetworks ⇒ Boolean Also known as: allow_conflicting_subnetworks?

Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network. Corresponds to the JSON property allowConflictingSubnetworks

Returns:

  • (Boolean) 


64482
64483
64484
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64482

def allow_conflicting_subnetworks
  @allow_conflicting_subnetworks
end

#as_paths ⇒ Array<Google::Apis::ComputeAlpha::RouteAsPath>

Output only. [Output Only] AS path. Corresponds to the JSON property asPaths

Returns:



64488
64489
64490
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64488

def as_paths
  @as_paths
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


64494
64495
64496
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64494

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

An optional description of this resource. Provide this field when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


64500
64501
64502
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64500

def description
  @description
end

#dest_range ⇒ String

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format. Corresponds to the JSON property destRange

Returns:

  • (String) 


64509
64510
64511
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64509

def dest_range
  @dest_range
end

#id ⇒ Fixnum

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


64516
64517
64518
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64516

def id
  @id
end

#ilb_route_behavior_on_unhealthy ⇒ String

ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. Corresponds to the JSON property ilbRouteBehaviorOnUnhealthy

Returns:

  • (String) 


64522
64523
64524
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64522

def ilb_route_behavior_on_unhealthy
  @ilb_route_behavior_on_unhealthy
end

#kind ⇒ String

Output only. [Output Only] Type of this resource. Always compute#routes for Route resources. Corresponds to the JSON property kind

Returns:

  • (String) 


64528
64529
64530
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64528

def kind
  @kind
end

#name ⇒ String

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. Corresponds to the JSON property name

Returns:

  • (String) 


64539
64540
64541
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64539

def name
  @name
end

#network ⇒ String

Fully-qualified URL of the network that this route applies to. Corresponds to the JSON property network

Returns:

  • (String) 


64544
64545
64546
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64544

def network
  @network
end

#next_hop_gateway ⇒ String

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway Corresponds to the JSON property nextHopGateway

Returns:

  • (String) 


64551
64552
64553
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64551

def next_hop_gateway
  @next_hop_gateway
end

#next_hop_hub ⇒ String

Output only. [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. Corresponds to the JSON property nextHopHub

Returns:

  • (String) 


64558
64559
64560
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64558

def next_hop_hub
  @next_hop_hub
end

#next_hop_ilb ⇒ String

The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs:

  • https://www.googleapis.com/compute/v1/projects/project/regions/region/ forwardingRules/forwardingRule

  • regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses:

  • 10.128.0.56

  • 2001:db8::2d9:51:0:0

  • 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. Corresponds to the JSON property nextHopIlb

Returns:

  • (String) 


64581
64582
64583
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64581

def next_hop_ilb
  @next_hop_ilb
end

#next_hop_instance ⇒ String

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ Corresponds to the JSON property nextHopInstance

Returns:

  • (String) 


64589
64590
64591
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64589

def next_hop_instance
  @next_hop_instance
end

#next_hop_inter_region_cost ⇒ Fixnum

Output only. [Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions. Corresponds to the JSON property nextHopInterRegionCost

Returns:

  • (Fixnum) 


64597
64598
64599
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64597

def next_hop_inter_region_cost
  @next_hop_inter_region_cost
end

#next_hop_interconnect_attachment ⇒ String

Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment. Corresponds to the JSON property nextHopInterconnectAttachment

Returns:

  • (String) 


64607
64608
64609
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64607

def next_hop_interconnect_attachment
  @next_hop_interconnect_attachment
end

#next_hop_ip ⇒ String

The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. Corresponds to the JSON property nextHopIp

Returns:

  • (String) 


64618
64619
64620
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64618

def next_hop_ip
  @next_hop_ip
end

#next_hop_med ⇒ Fixnum

Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network. Corresponds to the JSON property nextHopMed

Returns:

  • (Fixnum) 


64625
64626
64627
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64625

def next_hop_med
  @next_hop_med
end

#next_hop_network ⇒ String

The URL of the local network if it should handle matching packets. Corresponds to the JSON property nextHopNetwork

Returns:

  • (String) 


64630
64631
64632
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64630

def next_hop_network
  @next_hop_network
end

#next_hop_origin ⇒ String

Output only. [Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. Corresponds to the JSON property nextHopOrigin

Returns:

  • (String) 


64637
64638
64639
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64637

def next_hop_origin
  @next_hop_origin
end

#next_hop_peering ⇒ String

Output only. [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. Corresponds to the JSON property nextHopPeering

Returns:

  • (String) 


64644
64645
64646
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64644

def next_hop_peering
  @next_hop_peering
end

#next_hop_vpn_tunnel ⇒ String

The URL to a VpnTunnel that should handle matching packets. Corresponds to the JSON property nextHopVpnTunnel

Returns:

  • (String) 


64649
64650
64651
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64649

def next_hop_vpn_tunnel
  @next_hop_vpn_tunnel
end

#params ⇒ Google::Apis::ComputeAlpha::RouteParams

Additional route parameters. Corresponds to the JSON property params

Returns:



64654
64655
64656
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64654

def params
  @params
end

#priority ⇒ Fixnum

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


64663
64664
64665
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64663

def priority
  @priority
end

#route_status ⇒ String

[Output only] The status of the route. This status applies to dynamic routes learned by Cloud Routers. It is also applicable to routes undergoing migration. Corresponds to the JSON property routeStatus

Returns:

  • (String) 


64670
64671
64672
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64670

def route_status
  @route_status
end

#route_type ⇒ String

Output only. [Output Only] The type of this route, which can be one of the following values:

  • 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers
  • 'SUBNET' for a route from a subnet of the VPC
  • 'BGP' for a route learned from a BGP peer of this router
  • 'STATIC' for a static route Corresponds to the JSON property routeType

Returns:

  • (String) 


64682
64683
64684
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64682

def route_type
  @route_type
end

#self_link ⇒ String

[Output Only] Server-defined fully-qualified URL for this resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


64687
64688
64689
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64687

def self_link
  @self_link
end

#self_link_with_id ⇒ String

Output only. [Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


64693
64694
64695
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64693

def self_link_with_id
  @self_link_with_id
end

#tags ⇒ Array<String>

A list of instance tags to which this route applies. Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


64698
64699
64700
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64698

def tags
  @tags
end

#warnings ⇒ Array<Google::Apis::ComputeAlpha::Route::Warning>

Output only. [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. Corresponds to the JSON property warnings

Returns:



64705
64706
64707
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64705

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



64712
64713
64714
64715
64716
64717
64718
64719
64720
64721
64722
64723
64724
64725
64726
64727
64728
64729
64730
64731
64732
64733
64734
64735
64736
64737
64738
64739
64740
64741
64742
64743
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 64712

def update!(**args)
  @allow_conflicting_subnetworks = args[:allow_conflicting_subnetworks] if args.key?(:allow_conflicting_subnetworks)
  @as_paths = args[:as_paths] if args.key?(:as_paths)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @dest_range = args[:dest_range] if args.key?(:dest_range)
  @id = args[:id] if args.key?(:id)
  @ilb_route_behavior_on_unhealthy = args[:ilb_route_behavior_on_unhealthy] if args.key?(:ilb_route_behavior_on_unhealthy)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @next_hop_gateway = args[:next_hop_gateway] if args.key?(:next_hop_gateway)
  @next_hop_hub = args[:next_hop_hub] if args.key?(:next_hop_hub)
  @next_hop_ilb = args[:next_hop_ilb] if args.key?(:next_hop_ilb)
  @next_hop_instance = args[:next_hop_instance] if args.key?(:next_hop_instance)
  @next_hop_inter_region_cost = args[:next_hop_inter_region_cost] if args.key?(:next_hop_inter_region_cost)
  @next_hop_interconnect_attachment = args[:next_hop_interconnect_attachment] if args.key?(:next_hop_interconnect_attachment)
  @next_hop_ip = args[:next_hop_ip] if args.key?(:next_hop_ip)
  @next_hop_med = args[:next_hop_med] if args.key?(:next_hop_med)
  @next_hop_network = args[:next_hop_network] if args.key?(:next_hop_network)
  @next_hop_origin = args[:next_hop_origin] if args.key?(:next_hop_origin)
  @next_hop_peering = args[:next_hop_peering] if args.key?(:next_hop_peering)
  @next_hop_vpn_tunnel = args[:next_hop_vpn_tunnel] if args.key?(:next_hop_vpn_tunnel)
  @params = args[:params] if args.key?(:params)
  @priority = args[:priority] if args.key?(:priority)
  @route_status = args[:route_status] if args.key?(:route_status)
  @route_type = args[:route_type] if args.key?(:route_type)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @tags = args[:tags] if args.key?(:tags)
  @warnings = args[:warnings] if args.key?(:warnings)
end