Class ForwardingRule.Builder (1.9.1)

public static final class ForwardingRule.Builder extends GeneratedMessageV3.Builder<ForwardingRule.Builder> implements ForwardingRuleOrBuilder

Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * Global * Regional A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.

Protobuf type google.cloud.compute.v1.ForwardingRule

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.MetadataFilter>
Returns
TypeDescription
ForwardingRule.Builder

addAllPorts(Iterable<String> values)

public ForwardingRule.Builder addAllPorts(Iterable<String> values)

The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the specified list of ports) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Parameter
NameDescription
valuesIterable<String>

The ports to add.

Returns
TypeDescription
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;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistration>
Returns
TypeDescription
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;

Parameter
NameDescription
valueMetadataFilter
Returns
TypeDescription
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;

Parameter
NameDescription
builderForValueMetadataFilter.Builder
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
valueMetadataFilter
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
builderForValueMetadataFilter.Builder
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetadataFilter.Builder

addPorts(String value)

public ForwardingRule.Builder addPorts(String value)

The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the specified list of ports) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Parameter
NameDescription
valueString

The ports to add.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

addPortsBytes(ByteString value)

public ForwardingRule.Builder addPortsBytes(ByteString value)

The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the specified list of ports) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Parameter
NameDescription
valueByteString

The bytes of the ports to add.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ForwardingRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ForwardingRule.Builder
Overrides

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;

Parameter
NameDescription
valueForwardingRuleServiceDirectoryRegistration
Returns
TypeDescription
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;

Parameter
NameDescription
builderForValueForwardingRuleServiceDirectoryRegistration.Builder
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
valueForwardingRuleServiceDirectoryRegistration
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
builderForValueForwardingRuleServiceDirectoryRegistration.Builder
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
ForwardingRuleServiceDirectoryRegistration.Builder

build()

public ForwardingRule build()
Returns
TypeDescription
ForwardingRule

buildPartial()

public ForwardingRule buildPartial()
Returns
TypeDescription
ForwardingRule

clear()

public ForwardingRule.Builder clear()
Returns
TypeDescription
ForwardingRule.Builder
Overrides

clearAllPorts()

public ForwardingRule.Builder clearAllPorts()

This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService.

optional bool all_ports = 445175796;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

clearCreationTimestamp()

public ForwardingRule.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
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;

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ForwardingRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ForwardingRule.Builder
Overrides

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;

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

clearIPAddress()

public ForwardingRule.Builder clearIPAddress()

IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in 100.1.2.3 * Full 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 loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, see IP address specifications. Must be set to 0.0.0.0 when the target is targetGrpcProxy that has validateForProxyless field set to true. For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided.

optional string I_p_address = 42976943;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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. This can only be specified for an external global forwarding rule. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

clearLabels()

public ForwardingRule.Builder clearLabels()
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ForwardingRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ForwardingRule.Builder
Overrides

clearPortRange()

public ForwardingRule.Builder clearPortRange()

This field can be used only if: - Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. Some types of forwarding target have constraints on the acceptable ports. For more information, see Port specifications. @pattern: \\d+(?:-\\d+)?

optional string port_range = 217518079;

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

clearPorts()

public ForwardingRule.Builder clearPorts()

The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the specified list of ports) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

public ForwardingRule.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

clearTarget()

public ForwardingRule.Builder clearTarget()

optional string target = 192835985;

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

clone()

public ForwardingRule.Builder clone()
Returns
TypeDescription
ForwardingRule.Builder
Overrides

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAllPorts()

public boolean getAllPorts()

This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService.

optional bool all_ports = 445175796;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for backendService.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public ForwardingRule getDefaultInstanceForType()
Returns
TypeDescription
ForwardingRule

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for fingerprint.

getIPAddress()

public String getIPAddress()

IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in 100.1.2.3 * Full 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 loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, see IP address specifications. Must be set to 0.0.0.0 when the target is targetGrpcProxy that has validateForProxyless field set to true. For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided.

optional string I_p_address = 42976943;

Returns
TypeDescription
String

The iPAddress.

getIPAddressBytes()

public ByteString getIPAddressBytes()

IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in 100.1.2.3 * Full 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 loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, see IP address specifications. Must be set to 0.0.0.0 when the target is targetGrpcProxy that has validateForProxyless field set to true. For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided.

optional string I_p_address = 42976943;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
long

The id.

getIpVersion()

public String getIpVersion()

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
TypeDescription
String

The ipVersion.

getIpVersionBytes()

public ByteString getIpVersionBytes()

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
TypeDescription
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;

Returns
TypeDescription
boolean

The isMirroringCollector.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getLabelFingerprint()

public String getLabelFingerprint()

A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.

optional string label_fingerprint = 178124825;

Returns
TypeDescription
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.

optional string label_fingerprint = 178124825;

Returns
TypeDescription
ByteString

The bytes for labelFingerprint.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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;

Parameter
NameDescription
keyString
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

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

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for networkTier.

getPortRange()

public String getPortRange()

This field can be used only if: - Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. Some types of forwarding target have constraints on the acceptable ports. For more information, see Port specifications. @pattern: \\d+(?:-\\d+)?

optional string port_range = 217518079;

Returns
TypeDescription
String

The portRange.

getPortRangeBytes()

public ByteString getPortRangeBytes()

This field can be used only if: - Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. Some types of forwarding target have constraints on the acceptable ports. For more information, see Port specifications. @pattern: \\d+(?:-\\d+)?

optional string port_range = 217518079;

Returns
TypeDescription
ByteString

The bytes for portRange.

getPorts(int index)

public String getPorts(int index)

The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the specified list of ports) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The ports at the given index.

getPortsBytes(int index)

public ByteString getPortsBytes(int index)

The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the specified list of ports) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the ports at the given index.

getPortsCount()

public int getPortsCount()

The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the specified list of ports) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Returns
TypeDescription
int

The count of ports.

getPortsList()

public ProtocolStringList getPortsList()

The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the specified list of ports) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Returns
TypeDescription
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;

Returns
TypeDescription
long

The pscConnectionId.

getPscConnectionStatus()

public String getPscConnectionStatus()

Check the PscConnectionStatus enum for the list of possible values.

optional string psc_connection_status = 184149172;

Returns
TypeDescription
String

The pscConnectionStatus.

getPscConnectionStatusBytes()

public ByteString getPscConnectionStatusBytes()

Check the PscConnectionStatus enum for the list of possible values.

optional string psc_connection_status = 184149172;

Returns
TypeDescription
ByteString

The bytes for pscConnectionStatus.

getRegion()

public String getRegion()

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string region = 138946292;

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string region = 138946292;

Returns
TypeDescription
ByteString

The bytes for region.

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getServiceDirectoryRegistrations(int index)

public ForwardingRuleServiceDirectoryRegistration getServiceDirectoryRegistrations(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ForwardingRuleServiceDirectoryRegistration

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for subnetwork.

getTarget()

public String getTarget()

optional string target = 192835985;

Returns
TypeDescription
String

The target.

getTargetBytes()

public ByteString getTargetBytes()

optional string target = 192835985;

Returns
TypeDescription
ByteString

The bytes for target.

hasAllPorts()

public boolean hasAllPorts()

This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService.

optional bool all_ports = 445175796;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
boolean

Whether the backendService field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasFingerprint()

public boolean hasFingerprint()

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.

optional string fingerprint = 234678500;

Returns
TypeDescription
boolean

Whether the fingerprint field is set.

hasIPAddress()

public boolean hasIPAddress()

IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in 100.1.2.3 * Full 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 loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, see IP address specifications. Must be set to 0.0.0.0 when the target is targetGrpcProxy that has validateForProxyless field set to true. For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided.

optional string I_p_address = 42976943;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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. This can only be specified for an external global forwarding rule. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
TypeDescription
boolean

Whether the ipVersion field is set.

hasIsMirroringCollector()

public boolean hasIsMirroringCollector()

Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.

optional bool is_mirroring_collector = 119255164;

Returns
TypeDescription
boolean

Whether the isMirroringCollector field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasLabelFingerprint()

public boolean hasLabelFingerprint()

A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.

optional string label_fingerprint = 178124825;

Returns
TypeDescription
boolean

Whether the labelFingerprint field is set.

hasLoadBalancingScheme()

public boolean hasLoadBalancingScheme()

Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. Check the LoadBalancingScheme enum for the list of possible values.

optional string load_balancing_scheme = 363890244;

Returns
TypeDescription
boolean

Whether the loadBalancingScheme field is set.

hasName()

public boolean hasName()

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

hasNetwork()

public 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;

Returns
TypeDescription
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;

Returns
TypeDescription
boolean

Whether the networkTier field is set.

hasPortRange()

public boolean hasPortRange()

This field can be used only if: - Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. Some types of forwarding target have constraints on the acceptable ports. For more information, see Port specifications. @pattern: \\d+(?:-\\d+)?

optional string port_range = 217518079;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
boolean

Whether the region field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasServiceLabel()

public boolean hasServiceLabel()

An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.

optional string service_label = 417008874;

Returns
TypeDescription
boolean

Whether the serviceLabel field is set.

hasServiceName()

public boolean hasServiceName()

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

optional string service_name = 359880149;

Returns
TypeDescription
boolean

Whether the serviceName field is set.

hasSubnetwork()

public 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;

Returns
TypeDescription
boolean

Whether the subnetwork field is set.

hasTarget()

public boolean hasTarget()

optional string target = 192835985;

Returns
TypeDescription
boolean

Whether the target field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ForwardingRule other)

public ForwardingRule.Builder mergeFrom(ForwardingRule other)
Parameter
NameDescription
otherForwardingRule
Returns
TypeDescription
ForwardingRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ForwardingRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ForwardingRule.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ForwardingRule.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ForwardingRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ForwardingRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ForwardingRule.Builder
Overrides

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;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
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;

Parameter
NameDescription
keyString
Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
ForwardingRule.Builder

setAllPorts(boolean value)

public ForwardingRule.Builder setAllPorts(boolean value)

This field is used along with the backend_service field for Internal TCP/UDP Load Balancing or Network Load Balancing, or with the target field for internal and external TargetInstance. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. For TCP, UDP and SCTP traffic, packets addressed to any ports will be forwarded to the target or backendService.

optional bool all_ports = 445175796;

Parameter
NameDescription
valueboolean

The allPorts to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueboolean

The allowGlobalAccess to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The backendService to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for backendService to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The creationTimestamp to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for creationTimestamp to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ForwardingRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ForwardingRule.Builder
Overrides

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;

Parameter
NameDescription
valueString

The fingerprint to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for fingerprint to set.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

setIPAddress(String value)

public ForwardingRule.Builder setIPAddress(String value)

IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in 100.1.2.3 * Full 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 loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, see IP address specifications. Must be set to 0.0.0.0 when the target is targetGrpcProxy that has validateForProxyless field set to true. For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided.

optional string I_p_address = 42976943;

Parameter
NameDescription
valueString

The iPAddress to set.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

setIPAddressBytes(ByteString value)

public ForwardingRule.Builder setIPAddressBytes(ByteString value)

IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule. If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address: * IPv4 dotted decimal, as in 100.1.2.3 * Full 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 loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, see IP address specifications. Must be set to 0.0.0.0 when the target is targetGrpcProxy that has validateForProxyless field set to true. For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided.

optional string I_p_address = 42976943;

Parameter
NameDescription
valueByteString

The bytes for iPAddress to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The iPProtocol to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for iPProtocol to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valuelong

The id to set.

Returns
TypeDescription
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. This can only be specified for an external global forwarding rule. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Parameter
NameDescription
valueString

The ipVersion to set.

Returns
TypeDescription
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. This can only be specified for an external global forwarding rule. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Parameter
NameDescription
valueByteString

The bytes for ipVersion to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueboolean

The isMirroringCollector to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The labelFingerprint to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for labelFingerprint to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The loadBalancingScheme to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for loadBalancingScheme to set.

Returns
TypeDescription
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;

Parameters
NameDescription
indexint
valueMetadataFilter
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
builderForValueMetadataFilter.Builder
Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The network to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for network to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The networkTier to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for networkTier to set.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

setPortRange(String value)

public ForwardingRule.Builder setPortRange(String value)

This field can be used only if: - Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. Some types of forwarding target have constraints on the acceptable ports. For more information, see Port specifications. @pattern: \\d+(?:-\\d+)?

optional string port_range = 217518079;

Parameter
NameDescription
valueString

The portRange to set.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

setPortRangeBytes(ByteString value)

public ForwardingRule.Builder setPortRangeBytes(ByteString value)

This field can be used only if: - Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED - IPProtocol is one of TCP, UDP, or SCTP. Packets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. Some types of forwarding target have constraints on the acceptable ports. For more information, see Port specifications. @pattern: \\d+(?:-\\d+)?

optional string port_range = 217518079;

Parameter
NameDescription
valueByteString

The bytes for portRange to set.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

setPorts(int index, String value)

public ForwardingRule.Builder setPorts(int index, String value)

The ports field is only supported when the forwarding rule references a backend_service directly. Only packets addressed to the specified list of ports) are forwarded to backends. You can only use one of ports and port_range, or allPorts. The three are mutually exclusive. You can specify a list of up to five ports, which can be non-contiguous. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint ports. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The ports to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valuelong

The pscConnectionId to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The pscConnectionStatus to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for pscConnectionStatus to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The region to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
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)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ForwardingRule.Builder
Overrides
public ForwardingRule.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueString

The selfLink to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for selfLink to set.

Returns
TypeDescription
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;

Parameters
NameDescription
indexint
valueForwardingRuleServiceDirectoryRegistration
Returns
TypeDescription
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;

Parameters
NameDescription
indexint
builderForValueForwardingRuleServiceDirectoryRegistration.Builder
Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The serviceLabel to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for serviceLabel to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The serviceName to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for serviceName to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The subnetwork to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes for subnetwork to set.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

setTarget(String value)

public ForwardingRule.Builder setTarget(String value)

optional string target = 192835985;

Parameter
NameDescription
valueString

The target to set.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

setTargetBytes(ByteString value)

public ForwardingRule.Builder setTargetBytes(ByteString value)

optional string target = 192835985;

Parameter
NameDescription
valueByteString

The bytes for target to set.

Returns
TypeDescription
ForwardingRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ForwardingRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ForwardingRule.Builder
Overrides