Class: Google::Apis::ComputeBeta::Route

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



30229
30230
30231
# File 'lib/google/apis/compute_beta/classes.rb', line 30229

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

Instance Attribute Details

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

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



30093
30094
30095
# File 'lib/google/apis/compute_beta/classes.rb', line 30093

def as_paths
  @as_paths
end

#creation_timestampString

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

Returns:

  • (String)


30098
30099
30100
# File 'lib/google/apis/compute_beta/classes.rb', line 30098

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)


30104
30105
30106
# File 'lib/google/apis/compute_beta/classes.rb', line 30104

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)


30110
30111
30112
# File 'lib/google/apis/compute_beta/classes.rb', line 30110

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)


30116
30117
30118
# File 'lib/google/apis/compute_beta/classes.rb', line 30116

def id
  @id
end

#kindString

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

Returns:

  • (String)


30121
30122
30123
# File 'lib/google/apis/compute_beta/classes.rb', line 30121

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)


30131
30132
30133
# File 'lib/google/apis/compute_beta/classes.rb', line 30131

def name
  @name
end

#networkString

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

Returns:

  • (String)


30136
30137
30138
# File 'lib/google/apis/compute_beta/classes.rb', line 30136

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)


30143
30144
30145
# File 'lib/google/apis/compute_beta/classes.rb', line 30143

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)


30152
30153
30154
# File 'lib/google/apis/compute_beta/classes.rb', line 30152

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)


30159
30160
30161
# File 'lib/google/apis/compute_beta/classes.rb', line 30159

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)


30166
30167
30168
# File 'lib/google/apis/compute_beta/classes.rb', line 30166

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)


30172
30173
30174
# File 'lib/google/apis/compute_beta/classes.rb', line 30172

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)


30177
30178
30179
# File 'lib/google/apis/compute_beta/classes.rb', line 30177

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)


30183
30184
30185
# File 'lib/google/apis/compute_beta/classes.rb', line 30183

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)


30188
30189
30190
# File 'lib/google/apis/compute_beta/classes.rb', line 30188

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)


30197
30198
30199
# File 'lib/google/apis/compute_beta/classes.rb', line 30197

def priority
  @priority
end

#route_statusString

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

Returns:

  • (String)


30202
30203
30204
# File 'lib/google/apis/compute_beta/classes.rb', line 30202

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)


30211
30212
30213
# File 'lib/google/apis/compute_beta/classes.rb', line 30211

def route_type
  @route_type
end

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

Returns:

  • (String)


30216
30217
30218
# File 'lib/google/apis/compute_beta/classes.rb', line 30216

def self_link
  @self_link
end

#tagsArray<String>

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

Returns:

  • (Array<String>)


30221
30222
30223
# File 'lib/google/apis/compute_beta/classes.rb', line 30221

def tags
  @tags
end

#warningsArray<Google::Apis::ComputeBeta::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



30227
30228
30229
# File 'lib/google/apis/compute_beta/classes.rb', line 30227

def warnings
  @warnings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30234
30235
30236
30237
30238
30239
30240
30241
30242
30243
30244
30245
30246
30247
30248
30249
30250
30251
30252
30253
30254
30255
30256
30257
# File 'lib/google/apis/compute_beta/classes.rb', line 30234

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_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)
  @tags = args[:tags] if args.key?(:tags)
  @warnings = args[:warnings] if args.key?(:warnings)
end