ForwardingRule (Compute Engine API beta-rev20220726-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.ForwardingRule

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class ForwardingRule
extends GenericJson
```
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/beta/globalForwardingRules) * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/forwardingRules) 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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ForwardingRule()

Constructors
Constructor and Description
`ForwardingRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ForwardingRule`	`clone()`
`byte[]`	`decodeFingerprint()` Fingerprint of this resource.
`byte[]`	`decodeLabelFingerprint()` A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
`ForwardingRule`	`encodeFingerprint(byte[] fingerprint)` Fingerprint of this resource.
`ForwardingRule`	`encodeLabelFingerprint(byte[] labelFingerprint)` A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
`Boolean`	`getAllowGlobalAccess()` This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
`Boolean`	`getAllPorts()` 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.
`String`	`getBackendService()` Identifies the backend service to which the forwarding rule sends traffic.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`String`	`getFingerprint()` Fingerprint of this resource.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getIPAddress()` IP address for which this forwarding rule accepts traffic.
`String`	`getIPProtocol()` The IP protocol to which this rule applies.
`String`	`getIpVersion()` The IP Version that will be used by this forwarding rule.
`Boolean`	`getIsMirroringCollector()` Indicates whether or not this load balancer can be used as a collector for packet mirroring.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getLabelFingerprint()` A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
`Map<String,String>`	`getLabels()` Labels for this resource.
`String`	`getLoadBalancingScheme()` Specifies the forwarding rule type.
`List<MetadataFilter>`	`getMetadataFilters()` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`String`	`getName()` Name of the resource; provided by the client when the resource is created.
`String`	`getNetwork()` This field is not used for external load balancing.
`String`	`getNetworkTier()` This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
`Boolean`	`getNoAutomateDnsZone()` This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
`String`	`getPortRange()` 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.
`List<String>`	`getPorts()` The ports field is only supported when the forwarding rule references a backend_service directly.
`BigInteger`	`getPscConnectionId()` [Output Only] The PSC connection id of the PSC Forwarding Rule.
`String`	`getPscConnectionStatus()`
`String`	`getRegion()` [Output Only] URL of the region where the regional forwarding rule resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`List<ForwardingRuleServiceDirectoryRegistration>`	`getServiceDirectoryRegistrations()` Service Directory resources to register this forwarding rule with.
`String`	`getServiceLabel()` An optional prefix to the service name for this Forwarding Rule.
`String`	`getServiceName()` [Output Only] The internal fully qualified service name for this Forwarding Rule.
`List<String>`	`getSourceIpRanges()` 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.
`String`	`getSubnetwork()` 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.
`String`	`getTarget()`
`ForwardingRule`	`set(String fieldName, Object value)`
`ForwardingRule`	`setAllowGlobalAccess(Boolean allowGlobalAccess)` This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
`ForwardingRule`	`setAllPorts(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.
`ForwardingRule`	`setBackendService(String backendService)` Identifies the backend service to which the forwarding rule sends traffic.
`ForwardingRule`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`ForwardingRule`	`setDescription(String description)` An optional description of this resource.
`ForwardingRule`	`setFingerprint(String fingerprint)` Fingerprint of this resource.
`ForwardingRule`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`ForwardingRule`	`setIPAddress(String iPAddress)` IP address for which this forwarding rule accepts traffic.
`ForwardingRule`	`setIPProtocol(String iPProtocol)` The IP protocol to which this rule applies.
`ForwardingRule`	`setIpVersion(String ipVersion)` The IP Version that will be used by this forwarding rule.
`ForwardingRule`	`setIsMirroringCollector(Boolean isMirroringCollector)` Indicates whether or not this load balancer can be used as a collector for packet mirroring.
`ForwardingRule`	`setKind(String kind)` [Output Only] Type of the resource.
`ForwardingRule`	`setLabelFingerprint(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.
`ForwardingRule`	`setLabels(Map<String,String> labels)` Labels for this resource.
`ForwardingRule`	`setLoadBalancingScheme(String loadBalancingScheme)` Specifies the forwarding rule type.
`ForwardingRule`	`setMetadataFilters(List<MetadataFilter> metadataFilters)` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`ForwardingRule`	`setName(String name)` Name of the resource; provided by the client when the resource is created.
`ForwardingRule`	`setNetwork(String network)` This field is not used for external load balancing.
`ForwardingRule`	`setNetworkTier(String networkTier)` This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
`ForwardingRule`	`setNoAutomateDnsZone(Boolean noAutomateDnsZone)` This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
`ForwardingRule`	`setPortRange(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.
`ForwardingRule`	`setPorts(List<String> ports)` The ports field is only supported when the forwarding rule references a backend_service directly.
`ForwardingRule`	`setPscConnectionId(BigInteger pscConnectionId)` [Output Only] The PSC connection id of the PSC Forwarding Rule.
`ForwardingRule`	`setPscConnectionStatus(String pscConnectionStatus)`
`ForwardingRule`	`setRegion(String region)` [Output Only] URL of the region where the regional forwarding rule resides.
`ForwardingRule`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`ForwardingRule`	`setServiceDirectoryRegistrations(List<ForwardingRuleServiceDirectoryRegistration> serviceDirectoryRegistrations)` Service Directory resources to register this forwarding rule with.
`ForwardingRule`	`setServiceLabel(String serviceLabel)` An optional prefix to the service name for this Forwarding Rule.
`ForwardingRule`	`setServiceName(String serviceName)` [Output Only] The internal fully qualified service name for this Forwarding Rule.
`ForwardingRule`	`setSourceIpRanges(List<String> 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.
`ForwardingRule`	`setSubnetwork(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.
`ForwardingRule`	`setTarget(String target)`

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ForwardingRule
```
public ForwardingRule()
```
- Method Detail
  - getIPAddress
```
public String getIPAddress()
```
    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` * 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](https://cloud.google.com/load-balancing/docs/forwarding-rule- concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number.
    
    Returns:
    
    value or null for none
  - setIPAddress
```
public ForwardingRule setIPAddress(String 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 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` * 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](https://cloud.google.com/load-balancing/docs/forwarding-rule- concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number.
    
    Parameters:
    
    iPAddress - iPAddress or null for none
  - getIPProtocol
```
public String getIPProtocol()
```
    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).
    
    Returns:
    
    value or null for none
  - setIPProtocol
```
public ForwardingRule setIPProtocol(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](https://cloud.google.com /load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
    
    Parameters:
    
    iPProtocol - iPProtocol or null for none
  - getAllPorts
```
public Boolean getAllPorts()
```
    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.
    
    Returns:
    
    value or null for none
  - setAllPorts
```
public ForwardingRule setAllPorts(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.
    
    Parameters:
    
    allPorts - allPorts or null for none
  - getAllowGlobalAccess
```
public Boolean getAllowGlobalAccess()
```
    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.
    
    Returns:
    
    value or null for none
  - setAllowGlobalAccess
```
public ForwardingRule setAllowGlobalAccess(Boolean 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.
    
    Parameters:
    
    allowGlobalAccess - allowGlobalAccess or null for none
  - getBackendService
```
public String getBackendService()
```
    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.
    
    Returns:
    
    value or null for none
  - setBackendService
```
public ForwardingRule setBackendService(String 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.
    
    Parameters:
    
    backendService - backendService or null for none
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public ForwardingRule setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public ForwardingRule setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getFingerprint
```
public String getFingerprint()
```
    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.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeFingerprint()
  - decodeFingerprint
```
public byte[] decodeFingerprint()
```
    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.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getFingerprint()
  - setFingerprint
```
public ForwardingRule setFingerprint(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.
    
    Parameters:
    
    fingerprint - fingerprint or null for none
    
    See Also:
    
    #encodeFingerprint()
  - encodeFingerprint
```
public ForwardingRule encodeFingerprint(byte[] 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.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getId
```
public BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public ForwardingRule setId(BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getIpVersion
```
public String getIpVersion()
```
    The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
    
    Returns:
    
    value or null for none
  - setIpVersion
```
public ForwardingRule setIpVersion(String ipVersion)
```
    The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
    
    Parameters:
    
    ipVersion - ipVersion or null for none
  - getIsMirroringCollector
```
public Boolean getIsMirroringCollector()
```
    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.
    
    Returns:
    
    value or null for none
  - setIsMirroringCollector
```
public ForwardingRule setIsMirroringCollector(Boolean 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.
    
    Parameters:
    
    isMirroringCollector - isMirroringCollector or null for none
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    
    Returns:
    
    value or null for none
  - setKind
```
public ForwardingRule setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    
    Parameters:
    
    kind - kind or null for none
  - getLabelFingerprint
```
public String getLabelFingerprint()
```
    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.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeLabelFingerprint()
  - decodeLabelFingerprint
```
public byte[] decodeLabelFingerprint()
```
    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.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getLabelFingerprint()
  - setLabelFingerprint
```
public ForwardingRule setLabelFingerprint(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.
    
    Parameters:
    
    labelFingerprint - labelFingerprint or null for none
    
    See Also:
    
    #encodeLabelFingerprint()
  - encodeLabelFingerprint
```
public ForwardingRule encodeLabelFingerprint(byte[] 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.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getLabels
```
public Map<String,String> getLabels()
```
    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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public ForwardingRule setLabels(Map<String,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.
    
    Parameters:
    
    labels - labels or null for none
  - getLoadBalancingScheme
```
public String getLoadBalancingScheme()
```
    Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
    
    Returns:
    
    value or null for none
  - setLoadBalancingScheme
```
public ForwardingRule setLoadBalancingScheme(String loadBalancingScheme)
```
    Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
    
    Parameters:
    
    loadBalancingScheme - loadBalancingScheme or null for none
  - getMetadataFilters
```
public List<MetadataFilter> getMetadataFilters()
```
    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.
    
    Returns:
    
    value or null for none
  - setMetadataFilters
```
public ForwardingRule setMetadataFilters(List<MetadataFilter> metadataFilters)
```
    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.
    
    Parameters:
    
    metadataFilters - metadataFilters or null for none
  - getName
```
public String getName()
```
    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.
    
    Returns:
    
    value or null for none
  - setName
```
public ForwardingRule setName(String 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.
    
    Parameters:
    
    name - name or null for none
  - getNetwork
```
public String getNetwork()
```
    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.
    
    Returns:
    
    value or null for none
  - setNetwork
```
public ForwardingRule setNetwork(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.
    
    Parameters:
    
    network - network or null for none
  - getNetworkTier
```
public String getNetworkTier()
```
    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.
    
    Returns:
    
    value or null for none
  - setNetworkTier
```
public ForwardingRule setNetworkTier(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.
    
    Parameters:
    
    networkTier - networkTier or null for none
  - getNoAutomateDnsZone
```
public Boolean getNoAutomateDnsZone()
```
    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.
    
    Returns:
    
    value or null for none
  - setNoAutomateDnsZone
```
public ForwardingRule setNoAutomateDnsZone(Boolean 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.
    
    Parameters:
    
    noAutomateDnsZone - noAutomateDnsZone or null for none
  - getPortRange
```
public String getPortRange()
```
    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](https://cloud.google.com/load-balancing/docs/forwarding-rule- concepts#port_specifications). @pattern: \\d+(?:-\\d+)?
    
    Returns:
    
    value or null for none
  - setPortRange
```
public ForwardingRule setPortRange(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](https://cloud.google.com/load-balancing/docs/forwarding-rule- concepts#port_specifications). @pattern: \\d+(?:-\\d+)?
    
    Parameters:
    
    portRange - portRange or null for none
  - getPorts
```
public List<String> getPorts()
```
    The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the [specified list of ports]((https://cloud.google.com /load-balancing/docs/forwarding-rule-concepts#port_specifications)) 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+)?
    
    Returns:
    
    value or null for none
  - setPorts
```
public ForwardingRule setPorts(List<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]((https://cloud.google.com /load-balancing/docs/forwarding-rule-concepts#port_specifications)) 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+)?
    
    Parameters:
    
    ports - ports or null for none
  - getPscConnectionId
```
public BigInteger getPscConnectionId()
```
    [Output Only] The PSC connection id of the PSC Forwarding Rule.
    
    Returns:
    
    value or null for none
  - setPscConnectionId
```
public ForwardingRule setPscConnectionId(BigInteger pscConnectionId)
```
    [Output Only] The PSC connection id of the PSC Forwarding Rule.
    
    Parameters:
    
    pscConnectionId - pscConnectionId or null for none
  - getPscConnectionStatus
```
public String getPscConnectionStatus()
```
    Returns:
    
    value or null for none
  - setPscConnectionStatus
```
public ForwardingRule setPscConnectionStatus(String pscConnectionStatus)
```
    Parameters:
    
    pscConnectionStatus - pscConnectionStatus or null for none
  - getRegion
```
public String getRegion()
```
    [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.
    
    Returns:
    
    value or null for none
  - setRegion
```
public ForwardingRule setRegion(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.
    
    Parameters:
    
    region - region or null for none
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public ForwardingRule setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getServiceDirectoryRegistrations
```
public List<ForwardingRuleServiceDirectoryRegistration> getServiceDirectoryRegistrations()
```
    Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
    
    Returns:
    
    value or null for none
  - setServiceDirectoryRegistrations
```
public ForwardingRule setServiceDirectoryRegistrations(List<ForwardingRuleServiceDirectoryRegistration> serviceDirectoryRegistrations)
```
    Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
    
    Parameters:
    
    serviceDirectoryRegistrations - serviceDirectoryRegistrations or null for none
  - getServiceLabel
```
public String getServiceLabel()
```
    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.
    
    Returns:
    
    value or null for none
  - setServiceLabel
```
public ForwardingRule setServiceLabel(String 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.
    
    Parameters:
    
    serviceLabel - serviceLabel or null for none
  - getServiceName
```
public String getServiceName()
```
    [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
    
    Returns:
    
    value or null for none
  - setServiceName
```
public ForwardingRule setServiceName(String serviceName)
```
    [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
    
    Parameters:
    
    serviceName - serviceName or null for none
  - getSourceIpRanges
```
public List<String> getSourceIpRanges()
```
    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).
    
    Returns:
    
    value or null for none
  - setSourceIpRanges
```
public ForwardingRule setSourceIpRanges(List<String> 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 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).
    
    Parameters:
    
    sourceIpRanges - sourceIpRanges or null for none
  - getSubnetwork
```
public String getSubnetwork()
```
    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.
    
    Returns:
    
    value or null for none
  - setSubnetwork
```
public ForwardingRule setSubnetwork(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.
    
    Parameters:
    
    subnetwork - subnetwork or null for none
  - getTarget
```
public String getTarget()
```
    Returns:
    
    value or null for none
  - setTarget
```
public ForwardingRule setTarget(String target)
```
    Parameters:
    
    target - target or null for none
  - set
```
public ForwardingRule set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public ForwardingRule clone()
```
    Overrides:
    
    clone in class GenericJson

Class ForwardingRule

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ForwardingRule

Method Detail

getIPAddress

setIPAddress

getIPProtocol

setIPProtocol

getAllPorts

setAllPorts

getAllowGlobalAccess

setAllowGlobalAccess

getBackendService

setBackendService

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getId

setId

getIpVersion

setIpVersion

getIsMirroringCollector

setIsMirroringCollector

getKind

setKind

getLabelFingerprint

decodeLabelFingerprint

setLabelFingerprint

encodeLabelFingerprint

getLabels

setLabels

getLoadBalancingScheme

setLoadBalancingScheme

getMetadataFilters

setMetadataFilters

getName

setName

getNetwork

setNetwork

getNetworkTier

setNetworkTier

getNoAutomateDnsZone

setNoAutomateDnsZone

getPortRange

setPortRange

getPorts

setPorts

getPscConnectionId

setPscConnectionId

getPscConnectionStatus

setPscConnectionStatus

getRegion

setRegion

getSelfLink

setSelfLink

getServiceDirectoryRegistrations

setServiceDirectoryRegistrations

getServiceLabel

setServiceLabel

getServiceName

setServiceName

getSourceIpRanges

setSourceIpRanges

getSubnetwork