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.



37862
37863
37864
# File 'lib/google/apis/compute_alpha/classes.rb', line 37862

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

Instance Attribute Details

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


37709
37710
37711
# File 'lib/google/apis/compute_alpha/classes.rb', line 37709

def allow_conflicting_subnetworks
  @allow_conflicting_subnetworks
end

#as_pathsArray<Google::Apis::ComputeAlpha::RouteAsPath>

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



37715
37716
37717
# File 'lib/google/apis/compute_alpha/classes.rb', line 37715

def as_paths
  @as_paths
end

#creation_timestampString

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

Returns:

  • (String)


37720
37721
37722
# File 'lib/google/apis/compute_alpha/classes.rb', line 37720

def creation_timestamp
  @creation_timestamp
end

#descriptionString

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

Returns:

  • (String)


37726
37727
37728
# File 'lib/google/apis/compute_alpha/classes.rb', line 37726

def description
  @description
end

#dest_rangeString

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)


37732
37733
37734
# File 'lib/google/apis/compute_alpha/classes.rb', line 37732

def dest_range
  @dest_range
end

#idFixnum

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

Returns:

  • (Fixnum)


37738
37739
37740
# File 'lib/google/apis/compute_alpha/classes.rb', line 37738

def id
  @id
end

#ilb_route_behavior_on_unhealthyString

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)


37744
37745
37746
# File 'lib/google/apis/compute_alpha/classes.rb', line 37744

def ilb_route_behavior_on_unhealthy
  @ilb_route_behavior_on_unhealthy
end

#kindString

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

Returns:

  • (String)


37749
37750
37751
# File 'lib/google/apis/compute_alpha/classes.rb', line 37749

def kind
  @kind
end

#nameString

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)


37759
37760
37761
# File 'lib/google/apis/compute_alpha/classes.rb', line 37759

def name
  @name
end

#networkString

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

Returns:

  • (String)


37764
37765
37766
# File 'lib/google/apis/compute_alpha/classes.rb', line 37764

def network
  @network
end

#next_hop_gatewayString

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)


37771
37772
37773
# File 'lib/google/apis/compute_alpha/classes.rb', line 37771

def next_hop_gateway
  @next_hop_gateway
end

#next_hop_ilbString

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)


37780
37781
37782
# File 'lib/google/apis/compute_alpha/classes.rb', line 37780

def next_hop_ilb
  @next_hop_ilb
end

#next_hop_instanceString

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)


37787
37788
37789
# File 'lib/google/apis/compute_alpha/classes.rb', line 37787

def next_hop_instance
  @next_hop_instance
end

#next_hop_interconnect_attachmentString

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


37794
37795
37796
# File 'lib/google/apis/compute_alpha/classes.rb', line 37794

def next_hop_interconnect_attachment
  @next_hop_interconnect_attachment
end

#next_hop_ipString

The network IP address of an instance that should handle matching packets. Only IPv4 is supported. Corresponds to the JSON property nextHopIp

Returns:

  • (String)


37800
37801
37802
# File 'lib/google/apis/compute_alpha/classes.rb', line 37800

def next_hop_ip
  @next_hop_ip
end

#next_hop_networkString

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

Returns:

  • (String)


37805
37806
37807
# File 'lib/google/apis/compute_alpha/classes.rb', line 37805

def next_hop_network
  @next_hop_network
end

#next_hop_peeringString

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

Returns:

  • (String)


37811
37812
37813
# File 'lib/google/apis/compute_alpha/classes.rb', line 37811

def next_hop_peering
  @next_hop_peering
end

#next_hop_vpn_tunnelString

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

Returns:

  • (String)


37816
37817
37818
# File 'lib/google/apis/compute_alpha/classes.rb', line 37816

def next_hop_vpn_tunnel
  @next_hop_vpn_tunnel
end

#priorityFixnum

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)


37825
37826
37827
# File 'lib/google/apis/compute_alpha/classes.rb', line 37825

def priority
  @priority
end

#route_statusString

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

Returns:

  • (String)


37830
37831
37832
# File 'lib/google/apis/compute_alpha/classes.rb', line 37830

def route_status
  @route_status
end

#route_typeString

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


37839
37840
37841
# File 'lib/google/apis/compute_alpha/classes.rb', line 37839

def route_type
  @route_type
end

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

Returns:

  • (String)


37844
37845
37846
# File 'lib/google/apis/compute_alpha/classes.rb', line 37844

def self_link
  @self_link
end

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

Returns:

  • (String)


37849
37850
37851
# File 'lib/google/apis/compute_alpha/classes.rb', line 37849

def self_link_with_id
  @self_link_with_id
end

#tagsArray<String>

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

Returns:

  • (Array<String>)


37854
37855
37856
# File 'lib/google/apis/compute_alpha/classes.rb', line 37854

def tags
  @tags
end

#warningsArray<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



37860
37861
37862
# File 'lib/google/apis/compute_alpha/classes.rb', line 37860

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



37867
37868
37869
37870
37871
37872
37873
37874
37875
37876
37877
37878
37879
37880
37881
37882
37883
37884
37885
37886
37887
37888
37889
37890
37891
37892
37893
# File 'lib/google/apis/compute_alpha/classes.rb', line 37867

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