public interface ForwardingRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Labels for this resource.
|
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 can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
|
String |
getBackendService()
Identifies the backend service to which the forwarding rule sends traffic.
|
com.google.protobuf.ByteString |
getBackendServiceBytes()
Identifies the backend service to which the forwarding rule sends traffic.
|
String |
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
|
com.google.protobuf.ByteString |
getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
|
String |
getDescription()
An optional description of this resource.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
An optional description of this resource.
|
String |
getFingerprint()
Fingerprint of this resource.
|
com.google.protobuf.ByteString |
getFingerprintBytes()
Fingerprint of this resource.
|
long |
getId()
[Output Only] The unique identifier for the resource.
|
String |
getIPAddress()
IP address for which this forwarding rule accepts traffic.
|
com.google.protobuf.ByteString |
getIPAddressBytes()
IP address for which this forwarding rule accepts traffic.
|
String |
getIPProtocol()
The IP protocol to which this rule applies.
|
com.google.protobuf.ByteString |
getIPProtocolBytes()
The IP protocol to which this rule applies.
|
String |
getIpVersion()
The IP Version that will be used by this forwarding rule.
|
com.google.protobuf.ByteString |
getIpVersionBytes()
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.
|
com.google.protobuf.ByteString |
getKindBytes()
[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.
|
com.google.protobuf.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.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Labels for this resource.
|
Map<String,String> |
getLabelsMap()
Labels for this resource.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Labels for this resource.
|
String |
getLabelsOrThrow(String key)
Labels for this resource.
|
String |
getLoadBalancingScheme()
Specifies the forwarding rule type.
|
com.google.protobuf.ByteString |
getLoadBalancingSchemeBytes()
Specifies the forwarding rule type.
|
MetadataFilter |
getMetadataFilters(int index)
Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
|
int |
getMetadataFiltersCount()
Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
|
List<MetadataFilter> |
getMetadataFiltersList()
Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
|
MetadataFilterOrBuilder |
getMetadataFiltersOrBuilder(int index)
Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
|
List<? extends MetadataFilterOrBuilder> |
getMetadataFiltersOrBuilderList()
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.
|
com.google.protobuf.ByteString |
getNameBytes()
Name of the resource; provided by the client when the resource is created.
|
String |
getNetwork()
This field is not used for external load balancing.
|
com.google.protobuf.ByteString |
getNetworkBytes()
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.
|
com.google.protobuf.ByteString |
getNetworkTierBytes()
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 only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
|
com.google.protobuf.ByteString |
getPortRangeBytes()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
|
String |
getPorts(int index)
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
|
com.google.protobuf.ByteString |
getPortsBytes(int index)
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
|
int |
getPortsCount()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
|
List<String> |
getPortsList()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
|
long |
getPscConnectionId()
[Output Only] The PSC connection id of the PSC Forwarding Rule.
|
String |
getPscConnectionStatus()
Check the PscConnectionStatus enum for the list of possible values.
|
com.google.protobuf.ByteString |
getPscConnectionStatusBytes()
Check the PscConnectionStatus enum for the list of possible values.
|
String |
getRegion()
[Output Only] URL of the region where the regional forwarding rule resides.
|
com.google.protobuf.ByteString |
getRegionBytes()
[Output Only] URL of the region where the regional forwarding rule resides.
|
String |
getSelfLink()
[Output Only] Server-defined URL for the resource.
|
com.google.protobuf.ByteString |
getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
|
ForwardingRuleServiceDirectoryRegistration |
getServiceDirectoryRegistrations(int index)
Service Directory resources to register this forwarding rule with.
|
int |
getServiceDirectoryRegistrationsCount()
Service Directory resources to register this forwarding rule with.
|
List<ForwardingRuleServiceDirectoryRegistration> |
getServiceDirectoryRegistrationsList()
Service Directory resources to register this forwarding rule with.
|
ForwardingRuleServiceDirectoryRegistrationOrBuilder |
getServiceDirectoryRegistrationsOrBuilder(int index)
Service Directory resources to register this forwarding rule with.
|
List<? extends ForwardingRuleServiceDirectoryRegistrationOrBuilder> |
getServiceDirectoryRegistrationsOrBuilderList()
Service Directory resources to register this forwarding rule with.
|
String |
getServiceLabel()
An optional prefix to the service name for this Forwarding Rule.
|
com.google.protobuf.ByteString |
getServiceLabelBytes()
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.
|
com.google.protobuf.ByteString |
getServiceNameBytes()
[Output Only] The internal fully qualified service name for this Forwarding Rule.
|
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.
|
com.google.protobuf.ByteString |
getSubnetworkBytes()
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()
The URL of the target resource to receive the matched traffic.
|
com.google.protobuf.ByteString |
getTargetBytes()
The URL of the target resource to receive the matched traffic.
|
boolean |
hasAllowGlobalAccess()
This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
|
boolean |
hasAllPorts()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
|
boolean |
hasBackendService()
Identifies the backend service to which the forwarding rule sends traffic.
|
boolean |
hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
|
boolean |
hasDescription()
An optional description of this resource.
|
boolean |
hasFingerprint()
Fingerprint of this resource.
|
boolean |
hasId()
[Output Only] The unique identifier for the resource.
|
boolean |
hasIPAddress()
IP address for which this forwarding rule accepts traffic.
|
boolean |
hasIPProtocol()
The IP protocol to which this rule applies.
|
boolean |
hasIpVersion()
The IP Version that will be used by this forwarding rule.
|
boolean |
hasIsMirroringCollector()
Indicates whether or not this load balancer can be used as a collector for packet mirroring.
|
boolean |
hasKind()
[Output Only] Type of the resource.
|
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.
|
boolean |
hasLoadBalancingScheme()
Specifies the forwarding rule type.
|
boolean |
hasName()
Name of the resource; provided by the client when the resource is created.
|
boolean |
hasNetwork()
This field is not used for external load balancing.
|
boolean |
hasNetworkTier()
This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
|
boolean |
hasNoAutomateDnsZone()
This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
|
boolean |
hasPortRange()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
|
boolean |
hasPscConnectionId()
[Output Only] The PSC connection id of the PSC Forwarding Rule.
|
boolean |
hasPscConnectionStatus()
Check the PscConnectionStatus enum for the list of possible values.
|
boolean |
hasRegion()
[Output Only] URL of the region where the regional forwarding rule resides.
|
boolean |
hasSelfLink()
[Output Only] Server-defined URL for the resource.
|
boolean |
hasServiceLabel()
An optional prefix to the service name for this Forwarding Rule.
|
boolean |
hasServiceName()
[Output Only] The internal fully qualified service name for this Forwarding Rule.
|
boolean |
hasSubnetwork()
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.
|
boolean |
hasTarget()
The URL of the target resource to receive the matched traffic.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofboolean 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:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](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.
optional string I_p_address = 42976943;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:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](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.
optional string I_p_address = 42976943;com.google.protobuf.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:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](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.
optional string I_p_address = 42976943;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](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Check the IPProtocolEnum enum for the list of possible values.
optional string I_p_protocol = 488094525;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). Check the IPProtocolEnum enum for the list of possible values.
optional string I_p_protocol = 488094525;com.google.protobuf.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](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). Check the IPProtocolEnum enum for the list of possible values.
optional string I_p_protocol = 488094525;boolean hasAllPorts()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.
optional bool all_ports = 445175796;boolean getAllPorts()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.
optional bool all_ports = 445175796;boolean hasAllowGlobalAccess()
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.
optional bool allow_global_access = 499409674;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.
optional bool allow_global_access = 499409674;boolean hasBackendService()
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.
optional string backend_service = 306946058;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.
optional string backend_service = 306946058;com.google.protobuf.ByteString getBackendServiceBytes()
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.
optional string backend_service = 306946058;boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;com.google.protobuf.ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;com.google.protobuf.ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;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;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;com.google.protobuf.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;boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;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;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;com.google.protobuf.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;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;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;boolean hasKind()
[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
optional string kind = 3292052;String getKind()
[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
optional string kind = 3292052;com.google.protobuf.ByteString getKindBytes()
[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
optional string kind = 3292052;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;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;com.google.protobuf.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;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;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;@Deprecated Map<String,String> getLabels()
getLabelsMap() instead.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;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;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;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;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;com.google.protobuf.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;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;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;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;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;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;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]([-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.
optional string name = 3373707;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.
optional string name = 3373707;com.google.protobuf.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]([-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.
optional string name = 3373707;boolean hasNetwork()
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.
optional string network = 232872494;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.
optional string network = 232872494;com.google.protobuf.ByteString getNetworkBytes()
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.
optional string network = 232872494;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;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;com.google.protobuf.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;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.
optional bool no_automate_dns_zone = 64546991;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.
optional bool no_automate_dns_zone = 64546991;boolean hasPortRange()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
optional string port_range = 217518079;String getPortRange()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
optional string port_range = 217518079;com.google.protobuf.ByteString getPortRangeBytes()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
optional string port_range = 217518079;List<String> getPortsList()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;int getPortsCount()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;String getPorts(int index)
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;index - The index of the element to return.com.google.protobuf.ByteString getPortsBytes(int index)
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;index - The index of the value to return.boolean hasPscConnectionId()
[Output Only] The PSC connection id of the PSC Forwarding Rule.
optional uint64 psc_connection_id = 292082397;long getPscConnectionId()
[Output Only] The PSC connection id of the PSC Forwarding Rule.
optional uint64 psc_connection_id = 292082397;boolean hasPscConnectionStatus()
Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;String getPscConnectionStatus()
Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;com.google.protobuf.ByteString getPscConnectionStatusBytes()
Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;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;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;com.google.protobuf.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;boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;com.google.protobuf.ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;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;
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;
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;
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;
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;
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]([-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.
optional string service_label = 417008874;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.
optional string service_label = 417008874;com.google.protobuf.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]([-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.
optional string service_label = 417008874;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;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;com.google.protobuf.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;boolean hasSubnetwork()
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.
optional string subnetwork = 307827694;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.
optional string subnetwork = 307827694;com.google.protobuf.ByteString getSubnetworkBytes()
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.
optional string subnetwork = 307827694;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](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_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.
optional string target = 192835985;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](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_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.
optional string target = 192835985;com.google.protobuf.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](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_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.
optional string target = 192835985;Copyright © 2023 Google LLC. All rights reserved.