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.

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



4730
4731
4732
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4730

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

Instance Attribute Details

#backend_service ⇒ String

This field is not used for external 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) 


4612
4613
4614
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4612

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) 


4617
4618
4619
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4617

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) 


4623
4624
4625
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4623

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) 


4629
4630
4631
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4629

def id
  @id
end

#ip_address ⇒ String

The IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP. For regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and 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, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule. Corresponds to the JSON property IPAddress

Returns:

  • (String) 


4598
4599
4600
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4598

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. Corresponds to the JSON property IPProtocol

Returns:

  • (String) 


4605
4606
4607
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4605

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 a global forwarding rule. Corresponds to the JSON property ipVersion

Returns:

  • (String) 


4635
4636
4637
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4635

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) 


4641
4642
4643
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4641

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, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). 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) 


4650
4651
4652
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4650

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


4660
4661
4662
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4660

def name
  @name
end

#network ⇒ String

This field is not used for external load balancing. For internal 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) 


4668
4669
4670
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4668

def network
  @network
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, 1883, 5222
  • TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222

- TargetVpnGateway: 500, 4500

Corresponds to the JSON property portRange

Returns:

  • (String) 


4687
4688
4689
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4687

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 single port or a comma separated list of ports can be configured. 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>) 


4697
4698
4699
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4697

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. Corresponds to the JSON property region

Returns:

  • (String) 


4703
4704
4705
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4703

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


4708
4709
4710
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4708

def self_link
  @self_link
end

#subnetwork ⇒ String

This field is not used for external 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) 


4718
4719
4720
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4718

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. This field is not used for internal load balancing. Corresponds to the JSON property target

Returns:

  • (String) 


4728
4729
4730
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4728

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4735

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