ForwardingRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)Represents a Forwarding Rule resource. Forwarding rule resources in
Google Cloud can be either regional or global in scope: *
Global <https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules>
*
Regional <https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules>
A forwarding rule and its corresponding IP address represent the
frontend configuration of a Google Cloud 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes | |
|---|---|
| Name | Description |
I_p_address |
str
IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: \* IP address number, as in 100.1.2.3 \* IPv6 address
range, as in 2600:1234::/96 \* Full resource 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 forwarding
rule's target or backendService, and in most cases, also the
loadBalancingScheme, determine the type of IP address that
you can use. For detailed information, see `IP address
specifications |
I_p_protocol |
str
The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in `Load balancing features |
all_ports |
bool
The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The allPorts field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true. This field is a member of oneof_ _all_ports.
|
allow_global_access |
bool
If set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created. This field is a member of oneof_ _allow_global_access.
|
allow_psc_global_access |
bool
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. This field is a member of oneof_ _allow_psc_global_access.
|
backend_service |
str
Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types. This field is a member of oneof_ _backend_service.
|
base_forwarding_rule |
str
[Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. This field is a member of oneof_ _base_forwarding_rule.
|
creation_timestamp |
str
[Output Only] Creation timestamp in RFC3339 text format. This field is a member of oneof_ _creation_timestamp.
|
description |
str
An optional description of this resource. Provide this property when you create the resource. This field is a member of oneof_ _description.
|
fingerprint |
str
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. This field is a member of oneof_ _fingerprint.
|
id |
int
[Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of oneof_ _id.
|
ip_version |
str
The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. Check the IpVersion enum for the list of possible values. This field is a member of oneof_ _ip_version.
|
is_mirroring_collector |
bool
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. This field is a member of oneof_ _is_mirroring_collector.
|
kind |
str
[Output Only] Type of the resource. Always compute#forwardingRule for forwarding rule resources. This field is a member of oneof_ _kind.
|
label_fingerprint |
str
A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. This field is a member of oneof_ _label_fingerprint.
|
labels |
MutableMapping[str, str]
Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. |
load_balancing_scheme |
str
Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. Check the LoadBalancingScheme enum for the list of possible values. This field is a member of oneof_ _load_balancing_scheme.
|
metadata_filters |
MutableSequence[google.cloud.compute_v1.types.MetadataFilter]
Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not 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. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. 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. |
name |
str
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. For
Private Service Connect forwarding rules that forward
traffic to Google APIs, the forwarding rule name must be a
1-20 characters string with lowercase letters and numbers
and must start with a letter.
This field is a member of oneof_ _name.
|
network |
str
This field is not used for global external load balancing. For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided. This field is a member of oneof_ _network.
|
network_tier |
str
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. Check the NetworkTier enum for the list of possible values. This field is a member of oneof_ _network_tier.
|
no_automate_dns_zone |
bool
This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable. This field is a member of oneof_ _no_automate_dns_zone.
|
port_range |
str
The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\d+)? This field is a member of oneof_ _port_range.
|
ports |
MutableSequence[str]
The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\d+(?:-\d+)? |
psc_connection_id |
int
[Output Only] The PSC connection id of the PSC forwarding rule. This field is a member of oneof_ _psc_connection_id.
|
psc_connection_status |
str
Check the PscConnectionStatus enum for the list of possible values. This field is a member of oneof_ _psc_connection_status.
|
region |
str
[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. This field is a member of oneof_ _region.
|
self_link |
str
[Output Only] Server-defined URL for the resource. This field is a member of oneof_ _self_link.
|
service_directory_registrations |
MutableSequence[google.cloud.compute_v1.types.ForwardingRuleServiceDirectoryRegistration]
Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. |
service_label |
str
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.
This field is a member of oneof_ _service_label.
|
service_name |
str
[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used for internal load balancing. This field is a member of oneof_ _service_name.
|
source_ip_ranges |
MutableSequence[str]
If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a forwarding rule can only have up to 64 source IP ranges, and this field can only be used with a regional forwarding rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). |
subnetwork |
str
This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. This field is a member of oneof_ _subnetwork.
|
target |
str
The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be 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 load balancers, see the "Target" column in `Port specifications |
Classes
IPProtocolEnum
IPProtocolEnum(value)The IP protocol to which this rule applies. For protocol forwarding,
valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The
valid IP protocols are different for different load balancing
products as described in Load balancing
features <https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends>__.
Values: UNDEFINED_I_P_PROTOCOL_ENUM (0): A value indicating that the enum field is not set. AH (2087): No description available. ESP (68962): No description available. ICMP (2241597): No description available. L3_DEFAULT (48151369): No description available. SCTP (2539724): No description available. TCP (82881): No description available. UDP (83873): No description available.
IpVersion
IpVersion(value)The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
Values: UNDEFINED_IP_VERSION (0): A value indicating that the enum field is not set. IPV4 (2254341): No description available. IPV6 (2254343): No description available. UNSPECIFIED_VERSION (21850000): No description available.
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
LoadBalancingScheme
LoadBalancingScheme(value)Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
Values: UNDEFINED_LOAD_BALANCING_SCHEME (0): A value indicating that the enum field is not set. EXTERNAL (35607499): No description available. EXTERNAL_MANAGED (512006923): No description available. INTERNAL (279295677): No description available. INTERNAL_MANAGED (37350397): No description available. INTERNAL_SELF_MANAGED (236211150): No description available. INVALID (530283991): No description available.
NetworkTier
NetworkTier(value)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.
Values: UNDEFINED_NETWORK_TIER (0): A value indicating that the enum field is not set. FIXED_STANDARD (310464328): Public internet quality with fixed bandwidth. PREMIUM (399530551): High quality, Google-grade network tier, support for all networking products. STANDARD (484642493): Public internet quality, only limited support for other networking products. STANDARD_OVERRIDES_FIXED_STANDARD (465847234): (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
PscConnectionStatus
PscConnectionStatus(value)Values: UNDEFINED_PSC_CONNECTION_STATUS (0): A value indicating that the enum field is not set. ACCEPTED (246714279): The connection has been accepted by the producer. CLOSED (380163436): The connection has been closed by the producer and will not serve traffic going forward. NEEDS_ATTENTION (344491452): The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic. PENDING (35394935): The connection is pending acceptance by the producer. REJECTED (174130302): The connection has been rejected by the producer. STATUS_UNSPECIFIED (42133066): No description available.