Interface ForwardingRuleOrBuilder (1.47.0)

public interface ForwardingRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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.

map<string, string> labels = 500195327;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAllPorts()

public abstract boolean getAllPorts()

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The allPorts field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true.

optional bool all_ports = 445175796;

Returns
TypeDescription
boolean

The allPorts.

getAllowGlobalAccess()

public abstract boolean getAllowGlobalAccess()

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.

optional bool allow_global_access = 499409674;

Returns
TypeDescription
boolean

The allowGlobalAccess.

getAllowPscGlobalAccess()

public abstract boolean getAllowPscGlobalAccess()

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

optional bool allow_psc_global_access = 263471819;

Returns
TypeDescription
boolean

The allowPscGlobalAccess.

getBackendService()

public abstract String getBackendService()

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.

optional string backend_service = 306946058;

Returns
TypeDescription
String

The backendService.

getBackendServiceBytes()

public abstract ByteString getBackendServiceBytes()

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.

optional string backend_service = 306946058;

Returns
TypeDescription
ByteString

The bytes for backendService.

getBaseForwardingRule()

public abstract String getBaseForwardingRule()

[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.

optional string base_forwarding_rule = 524873104;

Returns
TypeDescription
String

The baseForwardingRule.

getBaseForwardingRuleBytes()

public abstract ByteString getBaseForwardingRuleBytes()

[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.

optional string base_forwarding_rule = 524873104;

Returns
TypeDescription
ByteString

The bytes for baseForwardingRule.

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDescription()

public abstract String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getFingerprint()

public abstract 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.

optional string fingerprint = 234678500;

Returns
TypeDescription
String

The fingerprint.

getFingerprintBytes()

public abstract ByteString getFingerprintBytes()

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.

optional string fingerprint = 234678500;

Returns
TypeDescription
ByteString

The bytes for fingerprint.

getIPAddress()

public abstract 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 * IPv6 address range, as in 2600🔢:/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.

optional string I_p_address = 42976943;

Returns
TypeDescription
String

The iPAddress.

getIPAddressBytes()

public abstract ByteString getIPAddressBytes()

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🔢:/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.

optional string I_p_address = 42976943;

Returns
TypeDescription
ByteString

The bytes for iPAddress.

getIPProtocol()

public abstract 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. Check the IPProtocolEnum enum for the list of possible values.

optional string I_p_protocol = 488094525;

Returns
TypeDescription
String

The iPProtocol.

getIPProtocolBytes()

public abstract ByteString getIPProtocolBytes()

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.

optional string I_p_protocol = 488094525;

Returns
TypeDescription
ByteString

The bytes for iPProtocol.

getId()

public abstract long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getIpVersion()

public abstract String getIpVersion()

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.

optional string ip_version = 294959552;

Returns
TypeDescription
String

The ipVersion.

getIpVersionBytes()

public abstract ByteString getIpVersionBytes()

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.

optional string ip_version = 294959552;

Returns
TypeDescription
ByteString

The bytes for ipVersion.

getIsMirroringCollector()

public abstract 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.

optional bool is_mirroring_collector = 119255164;

Returns
TypeDescription
boolean

The isMirroringCollector.

getKind()

public abstract String getKind()

[Output Only] Type of the resource. Always compute#forwardingRule for forwarding rule resources.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public abstract ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#forwardingRule for forwarding rule resources.

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getLabelFingerprint()

public abstract 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.

optional string label_fingerprint = 178124825;

Returns
TypeDescription
String

The labelFingerprint.

getLabelFingerprintBytes()

public abstract ByteString getLabelFingerprintBytes()

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.

optional string label_fingerprint = 178124825;

Returns
TypeDescription
ByteString

The bytes for labelFingerprint.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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.

map<string, string> labels = 500195327;

Returns
TypeDescription
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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.

map<string, string> labels = 500195327;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 500195327;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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.

map<string, string> labels = 500195327;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLoadBalancingScheme()

public abstract String getLoadBalancingScheme()

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.

optional string load_balancing_scheme = 363890244;

Returns
TypeDescription
String

The loadBalancingScheme.

getLoadBalancingSchemeBytes()

public abstract ByteString getLoadBalancingSchemeBytes()

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.

optional string load_balancing_scheme = 363890244;

Returns
TypeDescription
ByteString

The bytes for loadBalancingScheme.

getMetadataFilters(int index)

public abstract MetadataFilter getMetadataFilters(int index)

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.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetadataFilter

getMetadataFiltersCount()

public abstract int getMetadataFiltersCount()

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.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Returns
TypeDescription
int

getMetadataFiltersList()

public abstract List<MetadataFilter> getMetadataFiltersList()

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.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Returns
TypeDescription
List<MetadataFilter>

getMetadataFiltersOrBuilder(int index)

public abstract MetadataFilterOrBuilder getMetadataFiltersOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetadataFilterOrBuilder

getMetadataFiltersOrBuilderList()

public abstract List<? extends MetadataFilterOrBuilder> getMetadataFiltersOrBuilderList()

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.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.MetadataFilterOrBuilder>

getName()

public abstract 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? 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.

optional string name = 3373707;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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? 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.

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getNetwork()

public abstract String getNetwork()

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.

optional string network = 232872494;

Returns
TypeDescription
String

The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

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.

optional string network = 232872494;

Returns
TypeDescription
ByteString

The bytes for network.

getNetworkTier()

public abstract 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. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Returns
TypeDescription
String

The networkTier.

getNetworkTierBytes()

public abstract ByteString getNetworkTierBytes()

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.

optional string network_tier = 517397843;

Returns
TypeDescription
ByteString

The bytes for networkTier.

getNoAutomateDnsZone()

public abstract 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. Once set, this field is not mutable.

optional bool no_automate_dns_zone = 64546991;

Returns
TypeDescription
boolean

The noAutomateDnsZone.

getPortRange()

public abstract String getPortRange()

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?

optional string port_range = 217518079;

Returns
TypeDescription
String

The portRange.

getPortRangeBytes()

public abstract ByteString getPortRangeBytes()

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?

optional string port_range = 217518079;

Returns
TypeDescription
ByteString

The bytes for portRange.

getPorts(int index)

public abstract String getPorts(int index)

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+)?

repeated string ports = 106854418;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The ports at the given index.

getPortsBytes(int index)

public abstract ByteString getPortsBytes(int index)

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+)?

repeated string ports = 106854418;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the ports at the given index.

getPortsCount()

public abstract int getPortsCount()

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+)?

repeated string ports = 106854418;

Returns
TypeDescription
int

The count of ports.

getPortsList()

public abstract List<String> getPortsList()

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+)?

repeated string ports = 106854418;

Returns
TypeDescription
List<String>

A list containing the ports.

getPscConnectionId()

public abstract long getPscConnectionId()

[Output Only] The PSC connection id of the PSC forwarding rule.

optional uint64 psc_connection_id = 292082397;

Returns
TypeDescription
long

The pscConnectionId.

getPscConnectionStatus()

public abstract String getPscConnectionStatus()

Check the PscConnectionStatus enum for the list of possible values.

optional string psc_connection_status = 184149172;

Returns
TypeDescription
String

The pscConnectionStatus.

getPscConnectionStatusBytes()

public abstract ByteString getPscConnectionStatusBytes()

Check the PscConnectionStatus enum for the list of possible values.

optional string psc_connection_status = 184149172;

Returns
TypeDescription
ByteString

The bytes for pscConnectionStatus.

getRegion()

public abstract 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.

optional string region = 138946292;

Returns
TypeDescription
String

The region.

getRegionBytes()

public abstract ByteString getRegionBytes()

[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.

optional string region = 138946292;

Returns
TypeDescription
ByteString

The bytes for region.

public abstract String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getServiceDirectoryRegistrations(int index)

public abstract ForwardingRuleServiceDirectoryRegistration getServiceDirectoryRegistrations(int index)

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

repeated .google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistration service_directory_registrations = 223549694;

Parameter
NameDescription
indexint
Returns
TypeDescription
ForwardingRuleServiceDirectoryRegistration

getServiceDirectoryRegistrationsCount()

public abstract int getServiceDirectoryRegistrationsCount()

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

repeated .google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistration service_directory_registrations = 223549694;

Returns
TypeDescription
int

getServiceDirectoryRegistrationsList()

public abstract List<ForwardingRuleServiceDirectoryRegistration> getServiceDirectoryRegistrationsList()

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

repeated .google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistration service_directory_registrations = 223549694;

Returns
TypeDescription
List<ForwardingRuleServiceDirectoryRegistration>

getServiceDirectoryRegistrationsOrBuilder(int index)

public abstract ForwardingRuleServiceDirectoryRegistrationOrBuilder getServiceDirectoryRegistrationsOrBuilder(int index)

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

repeated .google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistration service_directory_registrations = 223549694;

Parameter
NameDescription
indexint
Returns
TypeDescription
ForwardingRuleServiceDirectoryRegistrationOrBuilder

getServiceDirectoryRegistrationsOrBuilderList()

public abstract List<? extends ForwardingRuleServiceDirectoryRegistrationOrBuilder> getServiceDirectoryRegistrationsOrBuilderList()

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

repeated .google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistration service_directory_registrations = 223549694;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistrationOrBuilder>

getServiceLabel()

public abstract 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? 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.

optional string service_label = 417008874;

Returns
TypeDescription
String

The serviceLabel.

getServiceLabelBytes()

public abstract ByteString getServiceLabelBytes()

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? 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.

optional string service_label = 417008874;

Returns
TypeDescription
ByteString

The bytes for serviceLabel.

getServiceName()

public abstract String getServiceName()

[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used for internal load balancing.

optional string service_name = 359880149;

Returns
TypeDescription
String

The serviceName.

getServiceNameBytes()

public abstract ByteString getServiceNameBytes()

[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used for internal load balancing.

optional string service_name = 359880149;

Returns
TypeDescription
ByteString

The bytes for serviceName.

getSourceIpRanges(int index)

public abstract String getSourceIpRanges(int index)

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).

repeated string source_ip_ranges = 111563210;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The sourceIpRanges at the given index.

getSourceIpRangesBytes(int index)

public abstract ByteString getSourceIpRangesBytes(int index)

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).

repeated string source_ip_ranges = 111563210;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the sourceIpRanges at the given index.

getSourceIpRangesCount()

public abstract int getSourceIpRangesCount()

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).

repeated string source_ip_ranges = 111563210;

Returns
TypeDescription
int

The count of sourceIpRanges.

getSourceIpRangesList()

public abstract List<String> getSourceIpRangesList()

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).

repeated string source_ip_ranges = 111563210;

Returns
TypeDescription
List<String>

A list containing the sourceIpRanges.

getSubnetwork()

public abstract String getSubnetwork()

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.

optional string subnetwork = 307827694;

Returns
TypeDescription
String

The subnetwork.

getSubnetworkBytes()

public abstract ByteString getSubnetworkBytes()

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.

optional string subnetwork = 307827694;

Returns
TypeDescription
ByteString

The bytes for subnetwork.

getTarget()

public abstract String getTarget()

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.

optional string target = 192835985;

Returns
TypeDescription
String

The target.

getTargetBytes()

public abstract ByteString getTargetBytes()

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.

optional string target = 192835985;

Returns
TypeDescription
ByteString

The bytes for target.

hasAllPorts()

public abstract boolean hasAllPorts()

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The allPorts field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true.

optional bool all_ports = 445175796;

Returns
TypeDescription
boolean

Whether the allPorts field is set.

hasAllowGlobalAccess()

public abstract boolean hasAllowGlobalAccess()

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.

optional bool allow_global_access = 499409674;

Returns
TypeDescription
boolean

Whether the allowGlobalAccess field is set.

hasAllowPscGlobalAccess()

public abstract boolean hasAllowPscGlobalAccess()

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

optional bool allow_psc_global_access = 263471819;

Returns
TypeDescription
boolean

Whether the allowPscGlobalAccess field is set.

hasBackendService()

public abstract boolean hasBackendService()

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.

optional string backend_service = 306946058;

Returns
TypeDescription
boolean

Whether the backendService field is set.

hasBaseForwardingRule()

public abstract boolean hasBaseForwardingRule()

[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.

optional string base_forwarding_rule = 524873104;

Returns
TypeDescription
boolean

Whether the baseForwardingRule field is set.

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp field is set.

hasDescription()

public abstract boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasFingerprint()

public abstract boolean hasFingerprint()

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.

optional string fingerprint = 234678500;

Returns
TypeDescription
boolean

Whether the fingerprint field is set.

hasIPAddress()

public abstract boolean hasIPAddress()

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🔢:/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.

optional string I_p_address = 42976943;

Returns
TypeDescription
boolean

Whether the iPAddress field is set.

hasIPProtocol()

public abstract boolean hasIPProtocol()

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.

optional string I_p_protocol = 488094525;

Returns
TypeDescription
boolean

Whether the iPProtocol field is set.

hasId()

public abstract boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasIpVersion()

public abstract boolean hasIpVersion()

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.

optional string ip_version = 294959552;

Returns
TypeDescription
boolean

Whether the ipVersion field is set.

hasIsMirroringCollector()

public abstract boolean hasIsMirroringCollector()

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.

optional bool is_mirroring_collector = 119255164;

Returns
TypeDescription
boolean

Whether the isMirroringCollector field is set.

hasKind()

public abstract boolean hasKind()

[Output Only] Type of the resource. Always compute#forwardingRule for forwarding rule resources.

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasLabelFingerprint()

public abstract boolean hasLabelFingerprint()

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.

optional string label_fingerprint = 178124825;

Returns
TypeDescription
boolean

Whether the labelFingerprint field is set.

hasLoadBalancingScheme()

public abstract boolean hasLoadBalancingScheme()

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.

optional string load_balancing_scheme = 363890244;

Returns
TypeDescription
boolean

Whether the loadBalancingScheme field is set.

hasName()

public abstract boolean hasName()

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? 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.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

hasNetwork()

public abstract boolean hasNetwork()

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.

optional string network = 232872494;

Returns
TypeDescription
boolean

Whether the network field is set.

hasNetworkTier()

public abstract boolean hasNetworkTier()

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.

optional string network_tier = 517397843;

Returns
TypeDescription
boolean

Whether the networkTier field is set.

hasNoAutomateDnsZone()

public abstract boolean hasNoAutomateDnsZone()

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.

optional bool no_automate_dns_zone = 64546991;

Returns
TypeDescription
boolean

Whether the noAutomateDnsZone field is set.

hasPortRange()

public abstract boolean hasPortRange()

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?

optional string port_range = 217518079;

Returns
TypeDescription
boolean

Whether the portRange field is set.

hasPscConnectionId()

public abstract boolean hasPscConnectionId()

[Output Only] The PSC connection id of the PSC forwarding rule.

optional uint64 psc_connection_id = 292082397;

Returns
TypeDescription
boolean

Whether the pscConnectionId field is set.

hasPscConnectionStatus()

public abstract boolean hasPscConnectionStatus()

Check the PscConnectionStatus enum for the list of possible values.

optional string psc_connection_status = 184149172;

Returns
TypeDescription
boolean

Whether the pscConnectionStatus field is set.

hasRegion()

public abstract boolean hasRegion()

[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.

optional string region = 138946292;

Returns
TypeDescription
boolean

Whether the region field is set.

public abstract boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasServiceLabel()

public abstract boolean hasServiceLabel()

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? 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.

optional string service_label = 417008874;

Returns
TypeDescription
boolean

Whether the serviceLabel field is set.

hasServiceName()

public abstract boolean hasServiceName()

[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used for internal load balancing.

optional string service_name = 359880149;

Returns
TypeDescription
boolean

Whether the serviceName field is set.

hasSubnetwork()

public abstract boolean hasSubnetwork()

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.

optional string subnetwork = 307827694;

Returns
TypeDescription
boolean

Whether the subnetwork field is set.

hasTarget()

public abstract boolean hasTarget()

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.

optional string target = 192835985;

Returns
TypeDescription
boolean

Whether the target field is set.