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
Represents a Forwarding Rule resource. Forwarding rule resources in GCP can be either regional or global in scope:
- Global *
Regional
A forwarding rule and its corresponding IP address represent the frontend
configuration of a Google Cloud Platform load balancer. Forwarding rules can
also reference target instances and Cloud VPN Classic gateways (
targetVpnGateway).
For more information, read Forwarding rule concepts and Using protocol
forwarding.
(== resource_for
$api_version
.forwardingRules ==) (== resource_for$ api_version
.globalForwardingRules ==) (== resource_for$api_version
. regionForwardingRules ==)
Instance Attribute Summary collapse
-
#all_ports ⇒ Boolean
(also: #all_ports?)
This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
-
#allow_global_access ⇒ Boolean
(also: #allow_global_access?)
This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
-
#backend_service ⇒ String
This field is only used for INTERNAL load balancing.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#fingerprint ⇒ String
Fingerprint of this resource.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#ip_address ⇒ String
IP address that this forwarding rule serves.
-
#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.
-
#is_mirroring_collector ⇒ Boolean
(also: #is_mirroring_collector?)
Indicates whether or not this load balancer can be used as a collector for packet mirroring.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#load_balancing_scheme ⇒ String
Specifies the forwarding rule type.
-
#metadata_filters ⇒ Array<Google::Apis::ComputeV1::MetadataFilter>
Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients.
-
#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.
-
#network_tier ⇒ String
This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD.
-
#port_range ⇒ String
When the load balancing scheme is EXTERNAL, INTERNAL_SELF_MANAGED and INTERNAL_MANAGED, you can specify a port_range.
-
#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.
-
#service_label ⇒ String
An optional prefix to the service name for this Forwarding Rule.
-
#service_name ⇒ String
[Output Only] The internal fully qualified service name for this Forwarding Rule.
-
#subnetwork ⇒ String
This field is only used for INTERNAL 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.
6734 6735 6736 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6734 def initialize(**args) update!(**args) end |
Instance Attribute Details
#all_ports ⇒ Boolean Also known as: all_ports?
This field is used along with the backend_service field for internal load
balancing or with the target field for internal TargetInstance. This field
cannot be used with port or portRange fields.
When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify
this field to allow packets addressed to any ports will be forwarded to the
backends configured with this forwarding rule.
Corresponds to the JSON property allPorts
6510 6511 6512 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6510 def all_ports @all_ports end |
#allow_global_access ⇒ Boolean Also known as: allow_global_access?
This field is used along with the backend_service field for internal load
balancing or with the target field for internal TargetInstance. If the field
is set to TRUE, clients can access ILB from all regions. Otherwise only allows
access from clients in the same region as the internal load balancer.
Corresponds to the JSON property allowGlobalAccess
6519 6520 6521 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6519 def allow_global_access @allow_global_access end |
#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
6527 6528 6529 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6527 def backend_service @backend_service end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
6532 6533 6534 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6532 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
6538 6539 6540 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6538 def description @description end |
#fingerprint ⇒ String
Fingerprint of this resource. A hash of the contents stored in this object.
This field is used in optimistic locking. This field will be ignored when
inserting a ForwardingRule. Include the fingerprint in patch request to ensure
that you do not overwrite changes that were applied from another concurrent
request.
To see the latest fingerprint, make a get() request to retrieve a
ForwardingRule.
Corresponds to the JSON property fingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
6550 6551 6552 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6550 def fingerprint @fingerprint end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
6556 6557 6558 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6556 def id @id end |
#ip_address ⇒ String
IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:
- IPv4 dotted decimal, as in
100.1.2.3
* Full URL, as in https://www. googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address- name * Partial URL or by name, as in: * projects/project_id/regions/region/ addresses/address-name * regions/region/addresses/address-name * global/ addresses/address-name * address-name The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to IP address specifications. Corresponds to the JSON propertyIPAddress
6486 6487 6488 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6486 def ip_address @ip_address end |
#ip_protocol ⇒ String
The IP protocol to which this rule applies. For protocol forwarding, valid
options are TCP, UDP, ESP, AH, SCTP or ICMP.
For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL,
and one of TCP or UDP are valid. For Traffic Director, the load balancing
scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S)
Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is
valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load
balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load
Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is
valid.
Corresponds to the JSON property IPProtocol
6500 6501 6502 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6500 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
6563 6564 6565 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6563 def ip_version @ip_version end |
#is_mirroring_collector ⇒ Boolean Also known as: is_mirroring_collector?
Indicates whether or not this load balancer can be used as a collector for
packet mirroring. To prevent mirroring loops, instances behind this load
balancer will not have their traffic mirrored even if a PacketMirroring rule
applies to them. This can only be set to true for load balancers that have
their loadBalancingScheme set to INTERNAL.
Corresponds to the JSON property isMirroringCollector
6572 6573 6574 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6572 def is_mirroring_collector @is_mirroring_collector end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#forwardingRule for
Forwarding Rule resources.
Corresponds to the JSON property kind
6579 6580 6581 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6579 def kind @kind end |
#load_balancing_scheme ⇒ String
Specifies the forwarding rule type.
- EXTERNAL is used for:
- Classic Cloud VPN gateways
- Protocol forwarding to VMs from an external IP address
- The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/ UDP
- INTERNAL is used for:
- Protocol forwarding to VMs from an internal IP address
- Internal TCP/UDP load balancers
- INTERNAL_MANAGED is used for:
- Internal HTTP(S) load balancers
- >INTERNAL_SELF_MANAGED is used for:
- Traffic Director
For more information about forwarding rules, refer to Forwarding rule concepts.
Corresponds to the JSON property
loadBalancingScheme
6598 6599 6600 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6598 def load_balancing_scheme @load_balancing_scheme end |
#metadata_filters ⇒ Array<Google::Apis::ComputeV1::MetadataFilter>
Opaque filter criteria used by Loadbalancer to restrict routing configuration
to a limited set of xDS compliant clients. In their xDS requests to
Loadbalancer, xDS clients present node metadata. If a match takes place, the
relevant configuration is made available to those proxies. Otherwise, all the
resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule will
not be visible to those proxies.
For each metadataFilter in this list, if its filterMatchCriteria is set to
MATCH_ANY, at least one of the filterLabels must match the corresponding label
provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then
all of its filterLabels must match with corresponding labels provided in the
metadata.
metadataFilters specified here will be applifed before those specified in the
UrlMap that this ForwardingRule references.
metadataFilters only applies to Loadbalancers that have their
loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Corresponds to the JSON property metadataFilters
6617 6618 6619 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6617 def @metadata_filters 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
6627 6628 6629 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6627 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
6635 6636 6637 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6635 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
6645 6646 6647 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6645 def network_tier @network_tier end |
#port_range ⇒ String
When the load balancing scheme is EXTERNAL, INTERNAL_SELF_MANAGED and INTERNAL_MANAGED, you can specify a port_range. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. 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
6666 6667 6668 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6666 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']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule. If the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways:
- A list of up to five ports, which can be non-contiguous * Keyword ALL, which
causes the forwarding rule to forward traffic on any port of the forwarding
rule's protocol.
Corresponds to the JSON property
ports
6680 6681 6682 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6680 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
6688 6689 6690 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6688 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
6693 6694 6695 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6693 def self_link @self_link end |
#service_label ⇒ String
An optional prefix to the service name for this Forwarding Rule. If specified,
the prefix is the first label of the fully qualified service name.
The label must be 1-63 characters long, and comply with RFC1035. Specifically,
the label 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.
This field is only used for internal load balancing.
Corresponds to the JSON property serviceLabel
6705 6706 6707 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6705 def service_label @service_label end |
#service_name ⇒ String
[Output Only] The internal fully qualified service name for this Forwarding
Rule.
This field is only used for internal load balancing.
Corresponds to the JSON property serviceName
6712 6713 6714 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6712 def service_name @service_name 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
6722 6723 6724 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6722 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 targetHttpProxy is
valid, not targetHttpsProxy.
Corresponds to the JSON property target
6732 6733 6734 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6732 def target @target end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 |
# File 'generated/google/apis/compute_v1/classes.rb', line 6739 def update!(**args) @ip_address = args[:ip_address] if args.key?(:ip_address) @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol) @all_ports = args[:all_ports] if args.key?(:all_ports) @allow_global_access = args[:allow_global_access] if args.key?(:allow_global_access) @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) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @ip_version = args[:ip_version] if args.key?(:ip_version) @is_mirroring_collector = args[:is_mirroring_collector] if args.key?(:is_mirroring_collector) @kind = args[:kind] if args.key?(:kind) @load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme) @metadata_filters = args[:metadata_filters] if args.key?(:metadata_filters) @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) @service_label = args[:service_label] if args.key?(:service_label) @service_name = args[:service_name] if args.key?(:service_name) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @target = args[:target] if args.key?(:target) end |