Class: Google::Apis::ComputeV1::ForwardingRule

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb

Overview

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [ IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta. globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1. regionForwardingRules ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ForwardingRule

Returns a new instance of ForwardingRule



5379
5380
5381
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5379

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

Instance Attribute Details

#backend_service ⇒ String

This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic. Corresponds to the JSON property backendService

Returns:

  • (String) 


5248
5249
5250
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5248

def backend_service
  @backend_service
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


5253
5254
5255
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5253

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

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

Returns:

  • (String) 


5259
5260
5261
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5259

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


5265
5266
5267
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5265

def id
  @id
end

#ip_address ⇒ String

The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme ( EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL reference to an existing Address resource ( internal regional static IP address), with a purpose of GCE_END_POINT and address_type of INTERNAL. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid:

Returns:

  • (String) 


5233
5234
5235
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5233

def ip_address
  @ip_address
end

#ip_protocol ⇒ String

The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid. Corresponds to the JSON property IPProtocol

Returns:

  • (String) 


5241
5242
5243
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5241

def ip_protocol
  @ip_protocol
end

#ip_version ⇒ String

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. Corresponds to the JSON property ipVersion

Returns:

  • (String) 


5272
5273
5274
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5272

def ip_version
  @ip_version
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. Corresponds to the JSON property kind

Returns:

  • (String) 


5278
5279
5280
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5278

def kind
  @kind
end

#load_balancing_scheme ⇒ String

This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) Corresponds to the JSON property loadBalancingScheme

Returns:

  • (String) 


5288
5289
5290
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5288

def load_balancing_scheme
  @load_balancing_scheme
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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property name

Returns:

  • (String) 


5298
5299
5300
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5298

def name
  @name
end

#network ⇒ String

This field is not used for external load balancing. For INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. Corresponds to the JSON property network

Returns:

  • (String) 


5306
5307
5308
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5306

def network
  @network
end

#network_tier ⇒ String

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. Corresponds to the JSON property networkTier

Returns:

  • (String) 


5316
5317
5318
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5316

def network_tier
  @network_tier
end

#port_range ⇒ String

This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports:

  • TargetHttpProxy: 80, 8080
  • TargetHttpsProxy: 443
  • TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222
  • TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222
  • TargetVpnGateway: 500, 4500 Corresponds to the JSON property portRange

Returns:

  • (String) 


5334
5335
5336
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5334

def port_range
  @port_range
end

#ports ⇒ Array<String>

This field is used along with the backend_service field for internal load balancing. When the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000'] etc. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. You may specify a maximum of up to 5 ports. Corresponds to the JSON property ports

Returns:

  • (Array<String>) 


5344
5345
5346
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5344

def ports
  @ports
end

#region ⇒ String

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. Corresponds to the JSON property region

Returns:

  • (String) 


5352
5353
5354
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5352

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


5357
5358
5359
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5357

def self_link
  @self_link
end

#subnetwork ⇒ String

This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. Corresponds to the JSON property subnetwork

Returns:

  • (String) 


5367
5368
5369
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5367

def subnetwork
  @subnetwork
end

#target ⇒ String

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED" load balancing, only HTTP and HTTPS targets are valid. Corresponds to the JSON property target

Returns:

  • (String) 


5377
5378
5379
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5377

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5384

def update!(**args)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol)
  @backend_service = args[:backend_service] if args.key?(:backend_service)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @ip_version = args[:ip_version] if args.key?(:ip_version)
  @kind = args[:kind] if args.key?(:kind)
  @load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @network_tier = args[:network_tier] if args.key?(:network_tier)
  @port_range = args[:port_range] if args.key?(:port_range)
  @ports = args[:ports] if args.key?(:ports)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @target = args[:target] if args.key?(:target)
end