public sealed class ForwardingRule : IMessage<ForwardingRule>, IEquatable<ForwardingRule>, IDeepCloneable<ForwardingRule>, IBufferMessage, IMessageReference documentation and code samples for the Compute Engine v1 API 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.
Implements
IMessageForwardingRule, IEquatableForwardingRule, IDeepCloneableForwardingRule, IBufferMessage, IMessageNamespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Constructors
ForwardingRule()
public ForwardingRule()ForwardingRule(ForwardingRule)
public ForwardingRule(ForwardingRule other)| Parameter | |
|---|---|
| Name | Description |
other | ForwardingRule |
Properties
AllowGlobalAccess
public bool AllowGlobalAccess { get; set; }This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy 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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
AllowPscGlobalAccess
public bool AllowPscGlobalAccess { get; set; }This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
| Property Value | |
|---|---|
| Type | Description |
bool | |
AllPorts
public bool AllPorts { get; set; }This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based 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 ports, port_range, and allPorts fields are mutually exclusive.
| Property Value | |
|---|---|
| Type | Description |
bool | |
BackendService
public string BackendService { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
BaseForwardingRule
public string BaseForwardingRule { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
string | |
CreationTimestamp
public string CreationTimestamp { get; set; }[Output Only] Creation timestamp in RFC3339 text format.
| Property Value | |
|---|---|
| Type | Description |
string | |
Description
public string Description { get; set; }An optional description of this resource. Provide this property when you create the resource.
| Property Value | |
|---|---|
| Type | Description |
string | |
Fingerprint
public string Fingerprint { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
HasAllowGlobalAccess
public bool HasAllowGlobalAccess { get; }Gets whether the "allow_global_access" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasAllowPscGlobalAccess
public bool HasAllowPscGlobalAccess { get; }Gets whether the "allow_psc_global_access" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasAllPorts
public bool HasAllPorts { get; }Gets whether the "all_ports" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasBackendService
public bool HasBackendService { get; }Gets whether the "backend_service" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasBaseForwardingRule
public bool HasBaseForwardingRule { get; }Gets whether the "base_forwarding_rule" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasCreationTimestamp
public bool HasCreationTimestamp { get; }Gets whether the "creation_timestamp" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasDescription
public bool HasDescription { get; }Gets whether the "description" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasFingerprint
public bool HasFingerprint { get; }Gets whether the "fingerprint" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasId
public bool HasId { get; }Gets whether the "id" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasIPAddress
public bool HasIPAddress { get; }Gets whether the "I_p_address" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasIPProtocol
public bool HasIPProtocol { get; }Gets whether the "I_p_protocol" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasIpVersion
public bool HasIpVersion { get; }Gets whether the "ip_version" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasIsMirroringCollector
public bool HasIsMirroringCollector { get; }Gets whether the "is_mirroring_collector" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasKind
public bool HasKind { get; }Gets whether the "kind" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasLabelFingerprint
public bool HasLabelFingerprint { get; }Gets whether the "label_fingerprint" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasLoadBalancingScheme
public bool HasLoadBalancingScheme { get; }Gets whether the "load_balancing_scheme" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasName
public bool HasName { get; }Gets whether the "name" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasNetwork
public bool HasNetwork { get; }Gets whether the "network" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasNetworkTier
public bool HasNetworkTier { get; }Gets whether the "network_tier" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasNoAutomateDnsZone
public bool HasNoAutomateDnsZone { get; }Gets whether the "no_automate_dns_zone" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasPortRange
public bool HasPortRange { get; }Gets whether the "port_range" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasPscConnectionId
public bool HasPscConnectionId { get; }Gets whether the "psc_connection_id" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasPscConnectionStatus
public bool HasPscConnectionStatus { get; }Gets whether the "psc_connection_status" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasRegion
public bool HasRegion { get; }Gets whether the "region" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasSelfLink
public bool HasSelfLink { get; }Gets whether the "self_link" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasServiceLabel
public bool HasServiceLabel { get; }Gets whether the "service_label" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasServiceName
public bool HasServiceName { get; }Gets whether the "service_name" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasSubnetwork
public bool HasSubnetwork { get; }Gets whether the "subnetwork" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasTarget
public bool HasTarget { get; }Gets whether the "target" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
Id
public ulong Id { get; set; }[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Property Value | |
|---|---|
| Type | Description |
ulong | |
IPAddress
public string IPAddress { get; set; }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. When reading an IPAddress, the API always returns the IP address number.
| Property Value | |
|---|---|
| Type | Description |
string | |
IPProtocol
public string IPProtocol { get; set; }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. Check the IPProtocolEnum enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string | |
IpVersion
public string IpVersion { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
IsMirroringCollector
public bool IsMirroringCollector { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
Kind
public string Kind { get; set; }[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
| Property Value | |
|---|---|
| Type | Description |
string | |
LabelFingerprint
public string LabelFingerprint { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
Labels
public MapField<string, string> Labels { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
LoadBalancingScheme
public string LoadBalancingScheme { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
MetadataFilters
public RepeatedField<MetadataFilter> MetadataFilters { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldMetadataFilter | |
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
Network
public string Network { get; set; }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 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.
| Property Value | |
|---|---|
| Type | Description |
string | |
NetworkTier
public string NetworkTier { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
NoAutomateDnsZone
public bool NoAutomateDnsZone { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
PortRange
public string PortRange { get; set; }This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. 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+)?
| Property Value | |
|---|---|
| Type | Description |
string | |
Ports
public RepeatedField<string> Ports { get; }This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based 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. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \d+(?:-\d+)?
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring | |
PscConnectionId
public ulong PscConnectionId { get; set; }[Output Only] The PSC connection id of the PSC Forwarding Rule.
| Property Value | |
|---|---|
| Type | Description |
ulong | |
PscConnectionStatus
public string PscConnectionStatus { get; set; }Check the PscConnectionStatus enum for the list of possible values.
| Property Value | |
|---|---|
| Type | Description |
string | |
Region
public string Region { get; set; }[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.
| Property Value | |
|---|---|
| Type | Description |
string | |
SelfLink
public string SelfLink { get; set; }[Output Only] Server-defined URL for the resource.
| Property Value | |
|---|---|
| Type | Description |
string | |
ServiceDirectoryRegistrations
public RepeatedField<ForwardingRuleServiceDirectoryRegistration> ServiceDirectoryRegistrations { get; }Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldForwardingRuleServiceDirectoryRegistration | |
ServiceLabel
public string ServiceLabel { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
ServiceName
public string ServiceName { get; set; }[Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
| Property Value | |
|---|---|
| Type | Description |
string | |
SourceIpRanges
public RepeatedField<string> SourceIpRanges { get; }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).
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring | |
Subnetwork
public string Subnetwork { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
Target
public string Target { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |