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



37124
37125
37126
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37124

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) 


36971
36972
36973
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36971

def allow_conflicting_subnetworks
  @allow_conflicting_subnetworks
end

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

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

Returns:



36977
36978
36979
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36977

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) 


36982
36983
36984
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36982

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) 


36988
36989
36990
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36988

def description
  @description
end

#dest_range ⇒ String

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Corresponds to the JSON property destRange

Returns:

  • (String) 


36994
36995
36996
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36994

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) 


37000
37001
37002
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37000

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) 


37006
37007
37008
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37006

def ilb_route_behavior_on_unhealthy
  @ilb_route_behavior_on_unhealthy
end

#kind ⇒ String

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

Returns:

  • (String) 


37011
37012
37013
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37011

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) 


37021
37022
37023
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37021

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) 


37026
37027
37028
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37026

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) 


37033
37034
37035
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37033

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


37042
37043
37044
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37042

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) 


37049
37050
37051
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37049

def next_hop_instance
  @next_hop_instance
end

#next_hop_interconnect_attachment ⇒ String

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

Returns:

  • (String) 


37056
37057
37058
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37056

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. Only IPv4 is supported. Corresponds to the JSON property nextHopIp

Returns:

  • (String) 


37062
37063
37064
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37062

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) 


37067
37068
37069
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37067

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) 


37073
37074
37075
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37073

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) 


37078
37079
37080
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37078

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) 


37087
37088
37089
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37087

def priority
  @priority
end

#route_status ⇒ String

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

Returns:

  • (String) 


37092
37093
37094
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37092

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) 


37101
37102
37103
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37101

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) 


37106
37107
37108
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37106

def self_link
  @self_link
end

#self_link_with_id ⇒ String

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

Returns:

  • (String) 


37111
37112
37113
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37111

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


37116
37117
37118
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37116

def tags
  @tags
end

#warnings ⇒ Array<Google::Apis::ComputeAlpha::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:



37122
37123
37124
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37122

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



37129
37130
37131
37132
37133
37134
37135
37136
37137
37138
37139
37140
37141
37142
37143
37144
37145
37146
37147
37148
37149
37150
37151
37152
37153
37154
37155
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 37129

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