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 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.
Inheritance
System.Object
ForwardingRule
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: Google.Apis.Compute.v1.dll
Syntax
public class ForwardingRule : IDirectResponseSchema
Properties
AllowGlobalAccess
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.
Declaration
[JsonProperty("allowGlobalAccess")]
public virtual bool? AllowGlobalAccess { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
AllPorts
This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load
Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports
and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets
addressed to any ports will be forwarded to the target or backendService.
Declaration
[JsonProperty("allPorts")]
public virtual bool? AllPorts { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
BackendService
Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP
Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.
Declaration
[JsonProperty("backendService")]
public virtual string BackendService { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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
| Type |
Description |
| System.String |
|
ETag
Declaration
public virtual string ETag { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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
| Type |
Description |
| System.String |
|
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
| Type |
Description |
| System.Nullable<System.UInt64> |
|
IPAddress
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, see IP address
specifications.
Must be set to 0.0.0.0 when the target is targetGrpcProxy that has validateForProxyless field set to true.
For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be
provided.
Declaration
[JsonProperty("IPAddress")]
public virtual string IPAddress { get; set; }
Property Value
| Type |
Description |
| System.String |
|
IPProtocol
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.
Declaration
[JsonProperty("IPProtocol")]
public virtual string IPProtocol { get; set; }
Property Value
| Type |
Description |
| System.String |
|
IpVersion
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.
Declaration
[JsonProperty("ipVersion")]
public virtual string IpVersion { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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 a
PacketMirroring rule applies to them. This can only be set to true for load balancers that have their
loadBalancingScheme set to INTERNAL.
Declaration
[JsonProperty("isMirroringCollector")]
public virtual bool? IsMirroringCollector { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
Kind
[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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 error 412 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
| Type |
Description |
| System.String |
|
Labels
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.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
| Type |
Description |
| System.Collections.Generic.IDictionary<System.String, System.String> |
|
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
| Type |
Description |
| System.String |
|
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.
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 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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Network
This field is not used for external load balancing. For Internal TCP/UDP 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. 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
| Type |
Description |
| System.String |
|
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 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.
Declaration
[JsonProperty("networkTier")]
public virtual string NetworkTier { get; set; }
Property Value
| Type |
Description |
| System.String |
|
PortRange
This field can be used only if: - Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or
INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range
will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The
three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint
ports. Some types of forwarding target have constraints on the acceptable ports. For more information, see
Port
specifications.
@pattern: \d+(?:-\d+)?
Declaration
[JsonProperty("portRange")]
public virtual string PortRange { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Ports
The ports field is only supported when the forwarding rule references a backend_service directly. Only
packets addressed to the specified list of
ports are
forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually
exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with
the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \d+(?:-\d+)?
Declaration
[JsonProperty("ports")]
public virtual IList<string> Ports { get; set; }
Property Value
| Type |
Description |
| System.Collections.Generic.IList<System.String> |
|
PscConnectionId
[Output Only] The PSC connection id of the PSC Forwarding Rule.
Declaration
[JsonProperty("pscConnectionId")]
public virtual ulong? PscConnectionId { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.UInt64> |
|
PscConnectionStatus
Declaration
[JsonProperty("pscConnectionStatus")]
public virtual string PscConnectionStatus { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Region
[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
| Type |
Description |
| System.String |
|
SelfLink
[Output Only] Server-defined URL for the resource.
Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ServiceDirectoryRegistrations
Service Directory resources to register this forwarding rule with. Currently, only supports a single Service
Directory resource. It is only supported for internal load balancing.
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 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.
Declaration
[JsonProperty("serviceLabel")]
public virtual string ServiceLabel { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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
| Type |
Description |
| System.String |
|
Subnetwork
This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule,
used in internal load balancing and network load balancing 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
| Type |
Description |
| System.String |
|
Target
Declaration
[JsonProperty("target")]
public virtual string Target { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Implements