- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class ForwardingRule.Builder extends GeneratedMessageV3.Builder<ForwardingRule.Builder> implements ForwardingRuleOrBuilderRepresents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * Global * Regional A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.
Protobuf type google.cloud.compute.v1.ForwardingRule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ForwardingRule.BuilderImplements
ForwardingRuleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addAllMetadataFilters(Iterable<? extends MetadataFilter> values)
public ForwardingRule.Builder addAllMetadataFilters(Iterable<? extends MetadataFilter> values)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;
| Name | Description |
| values | Iterable<? extends com.google.cloud.compute.v1.MetadataFilter> |
| Type | Description |
| ForwardingRule.Builder |
addAllPorts(Iterable<String> values)
public ForwardingRule.Builder addAllPorts(Iterable<String> values)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;
| Name | Description |
| values | Iterable<String>The ports to add. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
addAllServiceDirectoryRegistrations(Iterable<? extends ForwardingRuleServiceDirectoryRegistration> values)
public ForwardingRule.Builder addAllServiceDirectoryRegistrations(Iterable<? extends ForwardingRuleServiceDirectoryRegistration> values)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;
| Name | Description |
| values | Iterable<? extends com.google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistration> |
| Type | Description |
| ForwardingRule.Builder |
addMetadataFilters(MetadataFilter value)
public ForwardingRule.Builder addMetadataFilters(MetadataFilter value)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;
| Name | Description |
| value | MetadataFilter |
| Type | Description |
| ForwardingRule.Builder |
addMetadataFilters(MetadataFilter.Builder builderForValue)
public ForwardingRule.Builder addMetadataFilters(MetadataFilter.Builder builderForValue)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;
| Name | Description |
| builderForValue | MetadataFilter.Builder |
| Type | Description |
| ForwardingRule.Builder |
addMetadataFilters(int index, MetadataFilter value)
public ForwardingRule.Builder addMetadataFilters(int index, MetadataFilter value)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;
| Name | Description |
| index | int |
| value | MetadataFilter |
| Type | Description |
| ForwardingRule.Builder |
addMetadataFilters(int index, MetadataFilter.Builder builderForValue)
public ForwardingRule.Builder addMetadataFilters(int index, MetadataFilter.Builder builderForValue)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;
| Name | Description |
| index | int |
| builderForValue | MetadataFilter.Builder |
| Type | Description |
| ForwardingRule.Builder |
addMetadataFiltersBuilder()
public MetadataFilter.Builder addMetadataFiltersBuilder()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;
| Type | Description |
| MetadataFilter.Builder |
addMetadataFiltersBuilder(int index)
public MetadataFilter.Builder addMetadataFiltersBuilder(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;
| Name | Description |
| index | int |
| Type | Description |
| MetadataFilter.Builder |
addPorts(String value)
public ForwardingRule.Builder addPorts(String value)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;
| Name | Description |
| value | StringThe ports to add. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
addPortsBytes(ByteString value)
public ForwardingRule.Builder addPortsBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes of the ports to add. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ForwardingRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ForwardingRule.Builder |
addServiceDirectoryRegistrations(ForwardingRuleServiceDirectoryRegistration value)
public ForwardingRule.Builder addServiceDirectoryRegistrations(ForwardingRuleServiceDirectoryRegistration value)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;
| Name | Description |
| value | ForwardingRuleServiceDirectoryRegistration |
| Type | Description |
| ForwardingRule.Builder |
addServiceDirectoryRegistrations(ForwardingRuleServiceDirectoryRegistration.Builder builderForValue)
public ForwardingRule.Builder addServiceDirectoryRegistrations(ForwardingRuleServiceDirectoryRegistration.Builder builderForValue)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;
| Name | Description |
| builderForValue | ForwardingRuleServiceDirectoryRegistration.Builder |
| Type | Description |
| ForwardingRule.Builder |
addServiceDirectoryRegistrations(int index, ForwardingRuleServiceDirectoryRegistration value)
public ForwardingRule.Builder addServiceDirectoryRegistrations(int index, ForwardingRuleServiceDirectoryRegistration value)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;
| Name | Description |
| index | int |
| value | ForwardingRuleServiceDirectoryRegistration |
| Type | Description |
| ForwardingRule.Builder |
addServiceDirectoryRegistrations(int index, ForwardingRuleServiceDirectoryRegistration.Builder builderForValue)
public ForwardingRule.Builder addServiceDirectoryRegistrations(int index, ForwardingRuleServiceDirectoryRegistration.Builder builderForValue)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;
| Name | Description |
| index | int |
| builderForValue | ForwardingRuleServiceDirectoryRegistration.Builder |
| Type | Description |
| ForwardingRule.Builder |
addServiceDirectoryRegistrationsBuilder()
public ForwardingRuleServiceDirectoryRegistration.Builder addServiceDirectoryRegistrationsBuilder()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;
| Type | Description |
| ForwardingRuleServiceDirectoryRegistration.Builder |
addServiceDirectoryRegistrationsBuilder(int index)
public ForwardingRuleServiceDirectoryRegistration.Builder addServiceDirectoryRegistrationsBuilder(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;
| Name | Description |
| index | int |
| Type | Description |
| ForwardingRuleServiceDirectoryRegistration.Builder |
build()
public ForwardingRule build()| Type | Description |
| ForwardingRule |
buildPartial()
public ForwardingRule buildPartial()| Type | Description |
| ForwardingRule |
clear()
public ForwardingRule.Builder clear()| Type | Description |
| ForwardingRule.Builder |
clearAllPorts()
public ForwardingRule.Builder clearAllPorts()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearAllowGlobalAccess()
public ForwardingRule.Builder clearAllowGlobalAccess()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearBackendService()
public ForwardingRule.Builder clearBackendService()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearCreationTimestamp()
public ForwardingRule.Builder clearCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearDescription()
public ForwardingRule.Builder clearDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ForwardingRule.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| ForwardingRule.Builder |
clearFingerprint()
public ForwardingRule.Builder clearFingerprint()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearIPAddress()
public ForwardingRule.Builder clearIPAddress() 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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearIPProtocol()
public ForwardingRule.Builder clearIPProtocol()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearId()
public ForwardingRule.Builder clearId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearIpVersion()
public ForwardingRule.Builder clearIpVersion()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearIsMirroringCollector()
public ForwardingRule.Builder clearIsMirroringCollector()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearKind()
public ForwardingRule.Builder clearKind()[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
optional string kind = 3292052;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearLabelFingerprint()
public ForwardingRule.Builder clearLabelFingerprint()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearLabels()
public ForwardingRule.Builder clearLabels()| Type | Description |
| ForwardingRule.Builder |
clearLoadBalancingScheme()
public ForwardingRule.Builder clearLoadBalancingScheme()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearMetadataFilters()
public ForwardingRule.Builder clearMetadataFilters()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;
| Type | Description |
| ForwardingRule.Builder |
clearName()
public ForwardingRule.Builder clearName() 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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearNetwork()
public ForwardingRule.Builder clearNetwork()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearNetworkTier()
public ForwardingRule.Builder clearNetworkTier()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearNoAutomateDnsZone()
public ForwardingRule.Builder clearNoAutomateDnsZone()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ForwardingRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| ForwardingRule.Builder |
clearPortRange()
public ForwardingRule.Builder clearPortRange()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearPorts()
public ForwardingRule.Builder clearPorts()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearPscConnectionId()
public ForwardingRule.Builder clearPscConnectionId()[Output Only] The PSC connection id of the PSC Forwarding Rule.
optional uint64 psc_connection_id = 292082397;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearPscConnectionStatus()
public ForwardingRule.Builder clearPscConnectionStatus()Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearRegion()
public ForwardingRule.Builder clearRegion()[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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearSelfLink()
public ForwardingRule.Builder clearSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearServiceDirectoryRegistrations()
public ForwardingRule.Builder clearServiceDirectoryRegistrations()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;
| Type | Description |
| ForwardingRule.Builder |
clearServiceLabel()
public ForwardingRule.Builder clearServiceLabel() 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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearServiceName()
public ForwardingRule.Builder clearServiceName()[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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearSubnetwork()
public ForwardingRule.Builder clearSubnetwork()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;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clearTarget()
public ForwardingRule.Builder clearTarget()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 more information, 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.
optional string target = 192835985;
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
clone()
public ForwardingRule.Builder clone()| Type | Description |
| ForwardingRule.Builder |
containsLabels(String key)
public 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;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getAllPorts()
public 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;
| Type | Description |
| boolean | The allPorts. |
getAllowGlobalAccess()
public boolean getAllowGlobalAccess()This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer.
optional bool allow_global_access = 499409674;
| Type | Description |
| boolean | The allowGlobalAccess. |
getBackendService()
public String getBackendService()Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.
optional string backend_service = 306946058;
| Type | Description |
| String | The backendService. |
getBackendServiceBytes()
public 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;
| Type | Description |
| ByteString | The bytes for backendService. |
getCreationTimestamp()
public String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public ForwardingRule getDefaultInstanceForType()| Type | Description |
| ForwardingRule |
getDescription()
public String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getFingerprint()
public String getFingerprint()Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
optional string fingerprint = 234678500;
| Type | Description |
| String | The fingerprint. |
getFingerprintBytes()
public 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;
| Type | Description |
| ByteString | The bytes for fingerprint. |
getIPAddress()
public String getIPAddress() IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in 100.1.2.3 * 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;
| Type | Description |
| String | The iPAddress. |
getIPAddressBytes()
public 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;
| Type | Description |
| ByteString | The bytes for iPAddress. |
getIPProtocol()
public String getIPProtocol()The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in Load balancing features. Check the IPProtocolEnum enum for the list of possible values.
optional string I_p_protocol = 488094525;
| Type | Description |
| String | The iPProtocol. |
getIPProtocolBytes()
public 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;
| Type | Description |
| ByteString | The bytes for iPProtocol. |
getId()
public long getId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| long | The id. |
getIpVersion()
public 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;
| Type | Description |
| String | The ipVersion. |
getIpVersionBytes()
public 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;
| Type | Description |
| ByteString | The bytes for ipVersion. |
getIsMirroringCollector()
public boolean getIsMirroringCollector()Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.
optional bool is_mirroring_collector = 119255164;
| Type | Description |
| boolean | The isMirroringCollector. |
getKind()
public String getKind()[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
optional string kind = 3292052;
| Type | Description |
| String | The kind. |
getKindBytes()
public ByteString getKindBytes()[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
optional string kind = 3292052;
| Type | Description |
| ByteString | The bytes for kind. |
getLabelFingerprint()
public String getLabelFingerprint()A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
optional string label_fingerprint = 178124825;
| Type | Description |
| String | The labelFingerprint. |
getLabelFingerprintBytes()
public 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;
| Type | Description |
| ByteString | The bytes for labelFingerprint. |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Type | Description |
| Map<String,String> |
getLabelsCount()
public 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;
| Type | Description |
| int |
getLabelsMap()
public 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;
| Type | Description |
| Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public 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;
| Name | Description |
| key | String |
| defaultValue | String |
| Type | Description |
| String |
getLabelsOrThrow(String key)
public 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;
| Name | Description |
| key | String |
| Type | Description |
| String |
getLoadBalancingScheme()
public 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;
| Type | Description |
| String | The loadBalancingScheme. |
getLoadBalancingSchemeBytes()
public 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;
| Type | Description |
| ByteString | The bytes for loadBalancingScheme. |
getMetadataFilters(int index)
public 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;
| Name | Description |
| index | int |
| Type | Description |
| MetadataFilter |
getMetadataFiltersBuilder(int index)
public MetadataFilter.Builder getMetadataFiltersBuilder(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;
| Name | Description |
| index | int |
| Type | Description |
| MetadataFilter.Builder |
getMetadataFiltersBuilderList()
public List<MetadataFilter.Builder> getMetadataFiltersBuilderList()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;
| Type | Description |
| List<Builder> |
getMetadataFiltersCount()
public 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;
| Type | Description |
| int |
getMetadataFiltersList()
public 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;
| Type | Description |
| List<MetadataFilter> |
getMetadataFiltersOrBuilder(int index)
public 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;
| Name | Description |
| index | int |
| Type | Description |
| MetadataFilterOrBuilder |
getMetadataFiltersOrBuilderList()
public 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;
| Type | Description |
| List<? extends com.google.cloud.compute.v1.MetadataFilterOrBuilder> |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Type | Description |
| Map<String,String> |
getName()
public String getName() Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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;
| Type | Description |
| String | The name. |
getNameBytes()
public 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;
| Type | Description |
| ByteString | The bytes for name. |
getNetwork()
public String getNetwork()This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
optional string network = 232872494;
| Type | Description |
| String | The network. |
getNetworkBytes()
public 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;
| Type | Description |
| ByteString | The bytes for network. |
getNetworkTier()
public String getNetworkTier()This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. Check the NetworkTier enum for the list of possible values.
optional string network_tier = 517397843;
| Type | Description |
| String | The networkTier. |
getNetworkTierBytes()
public 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;
| Type | Description |
| ByteString | The bytes for networkTier. |
getNoAutomateDnsZone()
public boolean getNoAutomateDnsZone()This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.
optional bool no_automate_dns_zone = 64546991;
| Type | Description |
| boolean | The noAutomateDnsZone. |
getPortRange()
public 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;
| Type | Description |
| String | The portRange. |
getPortRangeBytes()
public 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;
| Type | Description |
| ByteString | The bytes for portRange. |
getPorts(int index)
public 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;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The ports at the given index. |
getPortsBytes(int index)
public 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;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the ports at the given index. |
getPortsCount()
public 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;
| Type | Description |
| int | The count of ports. |
getPortsList()
public ProtocolStringList 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;
| Type | Description |
| ProtocolStringList | A list containing the ports. |
getPscConnectionId()
public long getPscConnectionId()[Output Only] The PSC connection id of the PSC Forwarding Rule.
optional uint64 psc_connection_id = 292082397;
| Type | Description |
| long | The pscConnectionId. |
getPscConnectionStatus()
public String getPscConnectionStatus()Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;
| Type | Description |
| String | The pscConnectionStatus. |
getPscConnectionStatusBytes()
public ByteString getPscConnectionStatusBytes()Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;
| Type | Description |
| ByteString | The bytes for pscConnectionStatus. |
getRegion()
public String getRegion()[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Type | Description |
| String | The region. |
getRegionBytes()
public 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;
| Type | Description |
| ByteString | The bytes for region. |
getSelfLink()
public String getSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| ByteString | The bytes for selfLink. |
getServiceDirectoryRegistrations(int index)
public 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;
| Name | Description |
| index | int |
| Type | Description |
| ForwardingRuleServiceDirectoryRegistration |
getServiceDirectoryRegistrationsBuilder(int index)
public ForwardingRuleServiceDirectoryRegistration.Builder getServiceDirectoryRegistrationsBuilder(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;
| Name | Description |
| index | int |
| Type | Description |
| ForwardingRuleServiceDirectoryRegistration.Builder |
getServiceDirectoryRegistrationsBuilderList()
public List<ForwardingRuleServiceDirectoryRegistration.Builder> getServiceDirectoryRegistrationsBuilderList()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;
| Type | Description |
| List<Builder> |
getServiceDirectoryRegistrationsCount()
public 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;
| Type | Description |
| int |
getServiceDirectoryRegistrationsList()
public 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;
| Type | Description |
| List<ForwardingRuleServiceDirectoryRegistration> |
getServiceDirectoryRegistrationsOrBuilder(int index)
public 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;
| Name | Description |
| index | int |
| Type | Description |
| ForwardingRuleServiceDirectoryRegistrationOrBuilder |
getServiceDirectoryRegistrationsOrBuilderList()
public 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;
| Type | Description |
| List<? extends com.google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistrationOrBuilder> |
getServiceLabel()
public String getServiceLabel() An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression a-z? 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;
| Type | Description |
| String | The serviceLabel. |
getServiceLabelBytes()
public 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;
| Type | Description |
| ByteString | The bytes for serviceLabel. |
getServiceName()
public String getServiceName()[Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
optional string service_name = 359880149;
| Type | Description |
| String | The serviceName. |
getServiceNameBytes()
public 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;
| Type | Description |
| ByteString | The bytes for serviceName. |
getSubnetwork()
public String getSubnetwork()This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
optional string subnetwork = 307827694;
| Type | Description |
| String | The subnetwork. |
getSubnetworkBytes()
public 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;
| Type | Description |
| ByteString | The bytes for subnetwork. |
getTarget()
public 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 more information, 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.
optional string target = 192835985;
| Type | Description |
| String | The target. |
getTargetBytes()
public 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 more information, 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.
optional string target = 192835985;
| Type | Description |
| ByteString | The bytes for target. |
hasAllPorts()
public 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;
| Type | Description |
| boolean | Whether the allPorts field is set. |
hasAllowGlobalAccess()
public 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;
| Type | Description |
| boolean | Whether the allowGlobalAccess field is set. |
hasBackendService()
public 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;
| Type | Description |
| boolean | Whether the backendService field is set. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| boolean | Whether the creationTimestamp field is set. |
hasDescription()
public boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| boolean | Whether the description field is set. |
hasFingerprint()
public 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;
| Type | Description |
| boolean | Whether the fingerprint field is set. |
hasIPAddress()
public 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;
| Type | Description |
| boolean | Whether the iPAddress field is set. |
hasIPProtocol()
public 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;
| Type | Description |
| boolean | Whether the iPProtocol field is set. |
hasId()
public boolean hasId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| boolean | Whether the id field is set. |
hasIpVersion()
public 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;
| Type | Description |
| boolean | Whether the ipVersion field is set. |
hasIsMirroringCollector()
public 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;
| Type | Description |
| boolean | Whether the isMirroringCollector field is set. |
hasKind()
public boolean hasKind()[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
optional string kind = 3292052;
| Type | Description |
| boolean | Whether the kind field is set. |
hasLabelFingerprint()
public 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;
| Type | Description |
| boolean | Whether the labelFingerprint field is set. |
hasLoadBalancingScheme()
public 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;
| Type | Description |
| boolean | Whether the loadBalancingScheme field is set. |
hasName()
public 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;
| Type | Description |
| boolean | Whether the name field is set. |
hasNetwork()
public 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;
| Type | Description |
| boolean | Whether the network field is set. |
hasNetworkTier()
public 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;
| Type | Description |
| boolean | Whether the networkTier field is set. |
hasNoAutomateDnsZone()
public 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;
| Type | Description |
| boolean | Whether the noAutomateDnsZone field is set. |
hasPortRange()
public 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;
| Type | Description |
| boolean | Whether the portRange field is set. |
hasPscConnectionId()
public boolean hasPscConnectionId()[Output Only] The PSC connection id of the PSC Forwarding Rule.
optional uint64 psc_connection_id = 292082397;
| Type | Description |
| boolean | Whether the pscConnectionId field is set. |
hasPscConnectionStatus()
public boolean hasPscConnectionStatus()Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;
| Type | Description |
| boolean | Whether the pscConnectionStatus field is set. |
hasRegion()
public 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;
| Type | Description |
| boolean | Whether the region field is set. |
hasSelfLink()
public boolean hasSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| boolean | Whether the selfLink field is set. |
hasServiceLabel()
public 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;
| Type | Description |
| boolean | Whether the serviceLabel field is set. |
hasServiceName()
public 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;
| Type | Description |
| boolean | Whether the serviceName field is set. |
hasSubnetwork()
public 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;
| Type | Description |
| boolean | Whether the subnetwork field is set. |
hasTarget()
public 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 more information, 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.
optional string target = 192835985;
| Type | Description |
| boolean | Whether the target field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(ForwardingRule other)
public ForwardingRule.Builder mergeFrom(ForwardingRule other)| Name | Description |
| other | ForwardingRule |
| Type | Description |
| ForwardingRule.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ForwardingRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ForwardingRule.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public ForwardingRule.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| ForwardingRule.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ForwardingRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ForwardingRule.Builder |
putAllLabels(Map<String,String> values)
public ForwardingRule.Builder putAllLabels(Map<String,String> values)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;
| Name | Description |
| values | Map<String,String> |
| Type | Description |
| ForwardingRule.Builder |
putLabels(String key, String value)
public ForwardingRule.Builder putLabels(String key, String value)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;
| Name | Description |
| key | String |
| value | String |
| Type | Description |
| ForwardingRule.Builder |
removeLabels(String key)
public ForwardingRule.Builder removeLabels(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;
| Name | Description |
| key | String |
| Type | Description |
| ForwardingRule.Builder |
removeMetadataFilters(int index)
public ForwardingRule.Builder removeMetadataFilters(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;
| Name | Description |
| index | int |
| Type | Description |
| ForwardingRule.Builder |
removeServiceDirectoryRegistrations(int index)
public ForwardingRule.Builder removeServiceDirectoryRegistrations(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;
| Name | Description |
| index | int |
| Type | Description |
| ForwardingRule.Builder |
setAllPorts(boolean value)
public ForwardingRule.Builder setAllPorts(boolean value)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;
| Name | Description |
| value | booleanThe allPorts to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setAllowGlobalAccess(boolean value)
public ForwardingRule.Builder setAllowGlobalAccess(boolean value)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;
| Name | Description |
| value | booleanThe allowGlobalAccess to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setBackendService(String value)
public ForwardingRule.Builder setBackendService(String value)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;
| Name | Description |
| value | StringThe backendService to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setBackendServiceBytes(ByteString value)
public ForwardingRule.Builder setBackendServiceBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for backendService to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setCreationTimestamp(String value)
public ForwardingRule.Builder setCreationTimestamp(String value)[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Name | Description |
| value | StringThe creationTimestamp to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setCreationTimestampBytes(ByteString value)
public ForwardingRule.Builder setCreationTimestampBytes(ByteString value)[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Name | Description |
| value | ByteStringThe bytes for creationTimestamp to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setDescription(String value)
public ForwardingRule.Builder setDescription(String value)An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Name | Description |
| value | StringThe description to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public ForwardingRule.Builder setDescriptionBytes(ByteString value)An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Name | Description |
| value | ByteStringThe bytes for description to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ForwardingRule.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ForwardingRule.Builder |
setFingerprint(String value)
public ForwardingRule.Builder setFingerprint(String value)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;
| Name | Description |
| value | StringThe fingerprint to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setFingerprintBytes(ByteString value)
public ForwardingRule.Builder setFingerprintBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for fingerprint to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setIPAddress(String value)
public ForwardingRule.Builder setIPAddress(String value) 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;
| Name | Description |
| value | StringThe iPAddress to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setIPAddressBytes(ByteString value)
public ForwardingRule.Builder setIPAddressBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for iPAddress to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setIPProtocol(String value)
public ForwardingRule.Builder setIPProtocol(String value)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;
| Name | Description |
| value | StringThe iPProtocol to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setIPProtocolBytes(ByteString value)
public ForwardingRule.Builder setIPProtocolBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for iPProtocol to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setId(long value)
public ForwardingRule.Builder setId(long value)[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Name | Description |
| value | longThe id to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setIpVersion(String value)
public ForwardingRule.Builder setIpVersion(String value)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;
| Name | Description |
| value | StringThe ipVersion to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setIpVersionBytes(ByteString value)
public ForwardingRule.Builder setIpVersionBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for ipVersion to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setIsMirroringCollector(boolean value)
public ForwardingRule.Builder setIsMirroringCollector(boolean value)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;
| Name | Description |
| value | booleanThe isMirroringCollector to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setKind(String value)
public ForwardingRule.Builder setKind(String value)[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
optional string kind = 3292052;
| Name | Description |
| value | StringThe kind to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setKindBytes(ByteString value)
public ForwardingRule.Builder setKindBytes(ByteString value)[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
optional string kind = 3292052;
| Name | Description |
| value | ByteStringThe bytes for kind to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setLabelFingerprint(String value)
public ForwardingRule.Builder setLabelFingerprint(String value)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;
| Name | Description |
| value | StringThe labelFingerprint to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setLabelFingerprintBytes(ByteString value)
public ForwardingRule.Builder setLabelFingerprintBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for labelFingerprint to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setLoadBalancingScheme(String value)
public ForwardingRule.Builder setLoadBalancingScheme(String value)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;
| Name | Description |
| value | StringThe loadBalancingScheme to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setLoadBalancingSchemeBytes(ByteString value)
public ForwardingRule.Builder setLoadBalancingSchemeBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for loadBalancingScheme to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setMetadataFilters(int index, MetadataFilter value)
public ForwardingRule.Builder setMetadataFilters(int index, MetadataFilter value)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;
| Name | Description |
| index | int |
| value | MetadataFilter |
| Type | Description |
| ForwardingRule.Builder |
setMetadataFilters(int index, MetadataFilter.Builder builderForValue)
public ForwardingRule.Builder setMetadataFilters(int index, MetadataFilter.Builder builderForValue)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;
| Name | Description |
| index | int |
| builderForValue | MetadataFilter.Builder |
| Type | Description |
| ForwardingRule.Builder |
setName(String value)
public ForwardingRule.Builder setName(String value) 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;
| Name | Description |
| value | StringThe name to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public ForwardingRule.Builder setNameBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setNetwork(String value)
public ForwardingRule.Builder setNetwork(String value)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;
| Name | Description |
| value | StringThe network to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setNetworkBytes(ByteString value)
public ForwardingRule.Builder setNetworkBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for network to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setNetworkTier(String value)
public ForwardingRule.Builder setNetworkTier(String value)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;
| Name | Description |
| value | StringThe networkTier to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setNetworkTierBytes(ByteString value)
public ForwardingRule.Builder setNetworkTierBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for networkTier to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setNoAutomateDnsZone(boolean value)
public ForwardingRule.Builder setNoAutomateDnsZone(boolean value)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;
| Name | Description |
| value | booleanThe noAutomateDnsZone to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setPortRange(String value)
public ForwardingRule.Builder setPortRange(String value)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;
| Name | Description |
| value | StringThe portRange to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setPortRangeBytes(ByteString value)
public ForwardingRule.Builder setPortRangeBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for portRange to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setPorts(int index, String value)
public ForwardingRule.Builder setPorts(int index, String value)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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe ports to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setPscConnectionId(long value)
public ForwardingRule.Builder setPscConnectionId(long value)[Output Only] The PSC connection id of the PSC Forwarding Rule.
optional uint64 psc_connection_id = 292082397;
| Name | Description |
| value | longThe pscConnectionId to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setPscConnectionStatus(String value)
public ForwardingRule.Builder setPscConnectionStatus(String value)Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;
| Name | Description |
| value | StringThe pscConnectionStatus to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setPscConnectionStatusBytes(ByteString value)
public ForwardingRule.Builder setPscConnectionStatusBytes(ByteString value)Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;
| Name | Description |
| value | ByteStringThe bytes for pscConnectionStatus to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setRegion(String value)
public ForwardingRule.Builder setRegion(String value)[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;
| Name | Description |
| value | StringThe region to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setRegionBytes(ByteString value)
public ForwardingRule.Builder setRegionBytes(ByteString value)[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;
| Name | Description |
| value | ByteStringThe bytes for region to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ForwardingRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| ForwardingRule.Builder |
setSelfLink(String value)
public ForwardingRule.Builder setSelfLink(String value)[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Name | Description |
| value | StringThe selfLink to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setSelfLinkBytes(ByteString value)
public ForwardingRule.Builder setSelfLinkBytes(ByteString value)[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Name | Description |
| value | ByteStringThe bytes for selfLink to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setServiceDirectoryRegistrations(int index, ForwardingRuleServiceDirectoryRegistration value)
public ForwardingRule.Builder setServiceDirectoryRegistrations(int index, ForwardingRuleServiceDirectoryRegistration value)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;
| Name | Description |
| index | int |
| value | ForwardingRuleServiceDirectoryRegistration |
| Type | Description |
| ForwardingRule.Builder |
setServiceDirectoryRegistrations(int index, ForwardingRuleServiceDirectoryRegistration.Builder builderForValue)
public ForwardingRule.Builder setServiceDirectoryRegistrations(int index, ForwardingRuleServiceDirectoryRegistration.Builder builderForValue)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;
| Name | Description |
| index | int |
| builderForValue | ForwardingRuleServiceDirectoryRegistration.Builder |
| Type | Description |
| ForwardingRule.Builder |
setServiceLabel(String value)
public ForwardingRule.Builder setServiceLabel(String value) 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;
| Name | Description |
| value | StringThe serviceLabel to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setServiceLabelBytes(ByteString value)
public ForwardingRule.Builder setServiceLabelBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for serviceLabel to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setServiceName(String value)
public ForwardingRule.Builder setServiceName(String value)[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;
| Name | Description |
| value | StringThe serviceName to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setServiceNameBytes(ByteString value)
public ForwardingRule.Builder setServiceNameBytes(ByteString value)[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;
| Name | Description |
| value | ByteStringThe bytes for serviceName to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setSubnetwork(String value)
public ForwardingRule.Builder setSubnetwork(String value)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;
| Name | Description |
| value | StringThe subnetwork to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setSubnetworkBytes(ByteString value)
public ForwardingRule.Builder setSubnetworkBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for subnetwork to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setTarget(String value)
public ForwardingRule.Builder setTarget(String value)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 more information, 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.
optional string target = 192835985;
| Name | Description |
| value | StringThe target to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setTargetBytes(ByteString value)
public ForwardingRule.Builder setTargetBytes(ByteString value)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 more information, 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.
optional string target = 192835985;
| Name | Description |
| value | ByteStringThe bytes for target to set. |
| Type | Description |
| ForwardingRule.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ForwardingRule.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ForwardingRule.Builder |