Class: Google::Apis::ComputeV1::ForwardingRule
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::ForwardingRule
- 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
-
#backend_service ⇒ String
This field is not used for external load balancing.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#ip_address ⇒ String
The IP address that this forwarding rule is serving on behalf of.
-
#ip_protocol ⇒ String
The IP protocol to which this rule applies.
-
#ip_version ⇒ String
The IP Version that will be used by this forwarding rule.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#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).
-
#name ⇒ String
Name of the resource; provided by the client when the resource is created.
-
#network ⇒ String
This field is not used for external load balancing.
-
#port_range ⇒ String
This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
-
#ports ⇒ Array<String>
This field is used along with the backend_service field for internal load balancing.
-
#region ⇒ String
[Output Only] URL of the region where the regional forwarding rule resides.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#subnetwork ⇒ String
This field is not used for external load balancing.
-
#target ⇒ String
The URL of the target resource to receive the matched traffic.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ForwardingRule
constructor
A new instance of ForwardingRule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ ForwardingRule
Returns a new instance of ForwardingRule
4910 4911 4912 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4910 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
4792 4793 4794 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4792 def backend_service @backend_service end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
4797 4798 4799 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4797 def @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
4803 4804 4805 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4803 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
4809 4810 4811 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4809 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, 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:
- 100.1.2.3
- https://www.googleapis.com/compute/v1/projects/project/regions/region/ addresses/address
- projects/project/regions/region/addresses/address
- regions/region/addresses/address
- global/addresses/address
- address
Corresponds to the JSON property
IPAddress
4778 4779 4780 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4778 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
4785 4786 4787 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4785 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
4815 4816 4817 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4815 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
4821 4822 4823 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4821 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
4830 4831 4832 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4830 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
4840 4841 4842 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4840 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
4848 4849 4850 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4848 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, 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
4866 4867 4868 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4866 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
4876 4877 4878 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4876 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
4884 4885 4886 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4884 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
4889 4890 4891 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4889 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
4899 4900 4901 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4899 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.
Corresponds to the JSON property target
4908 4909 4910 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4908 def target @target end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4915 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 |