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



5068
5069
5070
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5068

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) 


4937
4938
4939
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4937

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) 


4942
4943
4944
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4942

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) 


4948
4949
4950
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4948

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) 


4954
4955
4956
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4954

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


4922
4923
4924
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4922

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) 


4930
4931
4932
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4930

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) 


4961
4962
4963
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4961

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) 


4967
4968
4969
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4967

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) 


4977
4978
4979
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4977

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) 


4987
4988
4989
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4987

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) 


4995
4996
4997
 
# File 'generated/google/apis/compute_v1/classes.rb', line 4995

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) 


5005
5006
5007
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5005

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) 


5023
5024
5025
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5023

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


5033
5034
5035
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5033

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) 


5041
5042
5043
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5041

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


5046
5047
5048
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5046

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) 


5056
5057
5058
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5056

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) 


5066
5067
5068
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5066

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
 
# File 'generated/google/apis/compute_v1/classes.rb', line 5073

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