Class ForwardingRule
Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud 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 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.
Inheritance
ForwardingRule
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class ForwardingRule : IDirectResponseSchema
Properties
AllPorts
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 requiresallPorts
be set to true.
Declaration
[JsonProperty("allPorts")]
public virtual bool? AllPorts { get; set; }
Property Value
AllowGlobalAccess
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.
Declaration
[JsonProperty("allowGlobalAccess")]
public virtual bool? AllowGlobalAccess { get; set; }
Property Value
AllowPscGlobalAccess
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another
region.
Declaration
[JsonProperty("allowPscGlobalAccess")]
public virtual bool? AllowPscGlobalAccess { get; set; }
Property Value
AllowPscPacketInjection
This is used in PSC consumer ForwardingRule to control whether the producer is allowed to inject packets
into the consumer's network. If set to true, the target service attachment must have tunneling enabled and
TunnelingConfig.RoutingMode set to PACKET_INJECTION Non-PSC forwarding rules should not use this field.
This field was never released to any customers and is deprecated and will be removed in the future.
Declaration
[JsonProperty("allowPscPacketInjection")]
public virtual bool? AllowPscPacketInjection { get; set; }
Property Value
AvailabilityGroup
[Output Only] Specifies the availability group of the forwarding rule. This field is for use by global
external passthrough load balancers (load balancing scheme EXTERNAL_PASSTHROUGH) and is set for the child
forwarding rules only.
Declaration
[JsonProperty("availabilityGroup")]
public virtual string AvailabilityGroup { get; set; }
Property Value
BackendService
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.
Declaration
[JsonProperty("backendService")]
public virtual string BackendService { get; set; }
Property Value
BaseForwardingRule
Output only. [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.
Declaration
[JsonProperty("baseForwardingRule")]
public virtual string BaseForwardingRule { get; set; }
Property Value
ChildForwardingRules
Output only. [Output Only] Applicable only to the parent forwarding rule of global external passthrough load
balancers. This field contains the list of child forwarding rule URLs associated with the parent forwarding
rule: one for each availability group. AVAILABILITY_GROUP0 will be the first element, and
AVAILABILITY_GROUP1 will be the second element.
Declaration
[JsonProperty("childForwardingRules")]
public virtual IList<string> ChildForwardingRules { get; set; }
Property Value
CreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Description
An optional description of this resource. Provide this property when you create the resource.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
ETag
Declaration
public virtual string ETag { get; set; }
Property Value
ExternalManagedBackendBucketMigrationState
Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible
values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to
EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be
used to migrate traffic to backend buckets attached to this forwarding rule by percentage using
externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be
set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set
to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some
traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
Declaration
[JsonProperty("externalManagedBackendBucketMigrationState")]
public virtual string ExternalManagedBackendBucketMigrationState { get; set; }
Property Value
ExternalManagedBackendBucketMigrationTestingPercentage
Determines the fraction of requests to backend buckets that should be processed by the global external
Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be
set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application
Load Balancer) and the migration state is TEST_BY_PERCENTAGE.
Declaration
[JsonProperty("externalManagedBackendBucketMigrationTestingPercentage")]
public virtual float? ExternalManagedBackendBucketMigrationTestingPercentage { get; set; }
Property Value
Fingerprint
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.
Declaration
[JsonProperty("fingerprint")]
public virtual string Fingerprint { get; set; }
Property Value
IPAddress
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 andvalidateForProxyless is set to true, theIPAddress 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
inhttps://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.
When reading an IPAddress, the API always returns the IP address number.
Declaration
[JsonProperty("IPAddress")]
public virtual string IPAddress { get; set; }
Property Value
IPAddresses
Declaration
[JsonProperty("IPAddresses")]
public virtual IList<string> IPAddresses { get; set; }
Property Value
IPProtocol
The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP,AH,
SCTP, ICMP andL3_DEFAULT. The valid IP protocols are different for different load balancing products as
described in Load balancing
features.
Declaration
[JsonProperty("IPProtocol")]
public virtual string IPProtocol { get; set; }
Property Value
Id
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
IpCollection
Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in
EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when
creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as
inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name -
regions/region/publicDelegatedPrefixes/sub-pdp-name
Declaration
[JsonProperty("ipCollection")]
public virtual string IpCollection { get; set; }
Property Value
IpVersion
The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
Declaration
[JsonProperty("ipVersion")]
public virtual string IpVersion { get; set; }
Property Value
IsMirroringCollector
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
aPacketMirroring rule applies to them. This can only be set to true for load balancers that have
theirloadBalancingScheme set to INTERNAL.
Declaration
[JsonProperty("isMirroringCollector")]
public virtual bool? IsMirroringCollector { get; set; }
Property Value
Kind
Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
LabelFingerprint
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 error412 conditionNotMet. To see the latest
fingerprint, make a get() request to retrieve a ForwardingRule.
Declaration
[JsonProperty("labelFingerprint")]
public virtual string LabelFingerprint { get; set; }
Property Value
Labels
Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value
pair must comply withRFC1035. Label values may be empty.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
LoadBalancingScheme
Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule
concepts.
Declaration
[JsonProperty("loadBalancingScheme")]
public virtual string LoadBalancingScheme { get; set; }
Property Value
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 itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels
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
multiplemetadataFilters 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 thisForwardingRule
references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set
toINTERNAL_SELF_MANAGED.
Declaration
[JsonProperty("metadataFilters")]
public virtual IList<MetadataFilter> MetadataFilters { get; set; }
Property Value
Name
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters
long, and comply withRFC1035. 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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Network
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.
Declaration
[JsonProperty("network")]
public virtual string Network { get; set; }
Property Value
NetworkTier
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 andSTANDARD. For
GlobalForwardingRule, the valid value isPREMIUM. 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.
Declaration
[JsonProperty("networkTier")]
public virtual string NetworkTier { get; set; }
Property Value
NoAutomateDnsZone
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.
Declaration
[JsonProperty("noAutomateDnsZone")]
public virtual bool? NoAutomateDnsZone { get; set; }
Property Value
ParentForwardingRule
Output only. [Output Only] Applicable only to the child forwarding rules of global external passthrough load
balancers. This field contains the URL of the parent forwarding rule.
Declaration
[JsonProperty("parentForwardingRule")]
public virtual string ParentForwardingRule { get; set; }
Property Value
PortRange
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 overlappingportRanges.
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+)?
Declaration
[JsonProperty("portRange")]
public virtual string PortRange { get; set; }
Property Value
Ports
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+)?
Declaration
[JsonProperty("ports")]
public virtual IList<string> Ports { get; set; }
Property Value
PscConnectionId
[Output Only] The PSC connection id of the PSC forwarding rule.
Declaration
[JsonProperty("pscConnectionId")]
public virtual ulong? PscConnectionId { get; set; }
Property Value
PscConnectionStatus
Declaration
[JsonProperty("pscConnectionStatus")]
public virtual string PscConnectionStatus { get; set; }
Property Value
Region
Output only. [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.
Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
SelfLink
[Output Only] Server-defined URL for the resource.
Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
SelfLinkWithId
Output only. [Output Only] Server-defined URL for this resource with the resource id.
Declaration
[JsonProperty("selfLinkWithId")]
public virtual string SelfLinkWithId { get; set; }
Property Value
ServiceDirectoryRegistrations
Service Directory resources to register this forwarding rule with. Currently, only supports a single Service
Directory resource.
Declaration
[JsonProperty("serviceDirectoryRegistrations")]
public virtual IList<ForwardingRuleServiceDirectoryRegistration> ServiceDirectoryRegistrations { get; set; }
Property Value
ServiceLabel
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 withRFC1035.
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.
Declaration
[JsonProperty("serviceLabel")]
public virtual string ServiceLabel { get; set; }
Property Value
ServiceName
[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used
for internal load balancing.
Declaration
[JsonProperty("serviceName")]
public virtual string ServiceName { get; set; }
Property Value
SourceIpRanges
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 isEXTERNAL. 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).
Declaration
[JsonProperty("sourceIpRanges")]
public virtual IList<string> SourceIpRanges { get; set; }
Property Value
Subnetwork
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.
Declaration
[JsonProperty("subnetwork")]
public virtual string Subnetwork { get; set; }
Property Value
Target
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.
- For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name
of a supported Google API bundle: - vpc-sc - APIs that support VPC Service
Controls. - all-apis - All supported Google APIs. - For Private
Service Connect forwarding rules that forward traffic to managed services, the target must be a service
attachment. The target is not mutable once set as a service attachment.
Declaration
[JsonProperty("target")]
public virtual string Target { get; set; }
Property Value
Implements