Class: Google::Apis::ComputeV1::Route

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/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 the Routes 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.



33846
33847
33848
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33846

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

Instance Attribute Details

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

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

Returns:



33705
33706
33707
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33705

def as_paths
  @as_paths
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


33710
33711
33712
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33710

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) 


33716
33717
33718
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33716

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) 


33724
33725
33726
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33724

def dest_range
  @dest_range
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


33730
33731
33732
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33730

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


33735
33736
33737
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33735

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 with RFC1035. 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) 


33745
33746
33747
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33745

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) 


33750
33751
33752
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33750

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) 


33757
33758
33759
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33757

def next_hop_gateway
  @next_hop_gateway
end

#next_hop_hub ⇒ String

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


33763
33764
33765
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33763

def next_hop_hub
  @next_hop_hub
end

#next_hop_ilb ⇒ String

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/ compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule Corresponds to the JSON property nextHopIlb

Returns:

  • (String) 


33772
33773
33774
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33772

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) 


33779
33780
33781
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33779

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


33789
33790
33791
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33789

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


33794
33795
33796
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33794

def next_hop_network
  @next_hop_network
end

#next_hop_peering ⇒ String

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

Returns:

  • (String) 


33800
33801
33802
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33800

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) 


33805
33806
33807
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33805

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


33814
33815
33816
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33814

def priority
  @priority
end

#route_status ⇒ String

[Output only] The status of the route. Corresponds to the JSON property routeStatus

Returns:

  • (String) 


33819
33820
33821
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33819

def route_status
  @route_status
end

#route_type ⇒ String

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


33828
33829
33830
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33828

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) 


33833
33834
33835
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33833

def self_link
  @self_link
end

#tags ⇒ Array<String>

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

Returns:

  • (Array<String>) 


33838
33839
33840
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33838

def tags
  @tags
end

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

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



33844
33845
33846
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33844

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



33851
33852
33853
33854
33855
33856
33857
33858
33859
33860
33861
33862
33863
33864
33865
33866
33867
33868
33869
33870
33871
33872
33873
33874
 
# File 'lib/google/apis/compute_v1/classes.rb', line 33851

def update!(**args)
  @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)
  @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_ip = args[:next_hop_ip] if args.key?(:next_hop_ip)
  @next_hop_network = args[:next_hop_network] if args.key?(:next_hop_network)
  @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)
  @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)
  @tags = args[:tags] if args.key?(:tags)
  @warnings = args[:warnings] if args.key?(:warnings)
end