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.



35046
35047
35048
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35046

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:



34900
34901
34902
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34900

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) 


34905
34906
34907
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34905

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) 


34911
34912
34913
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34911

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) 


34919
34920
34921
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34919

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) 


34925
34926
34927
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34925

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) 


34930
34931
34932
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34930

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) 


34940
34941
34942
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34940

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) 


34945
34946
34947
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34945

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) 


34952
34953
34954
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34952

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) 


34958
34959
34960
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34958

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


34972
34973
34974
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34972

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) 


34979
34980
34981
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34979

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) 


34989
34990
34991
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34989

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) 


34994
34995
34996
 
# File 'lib/google/apis/compute_v1/classes.rb', line 34994

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) 


35000
35001
35002
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35000

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) 


35005
35006
35007
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35005

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) 


35014
35015
35016
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35014

def priority
  @priority
end

#route_status ⇒ String

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

Returns:

  • (String) 


35019
35020
35021
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35019

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) 


35028
35029
35030
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35028

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) 


35033
35034
35035
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35033

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


35038
35039
35040
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35038

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:



35044
35045
35046
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35044

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



35051
35052
35053
35054
35055
35056
35057
35058
35059
35060
35061
35062
35063
35064
35065
35066
35067
35068
35069
35070
35071
35072
35073
35074
 
# File 'lib/google/apis/compute_v1/classes.rb', line 35051

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