Class ForwardingRule (1.58.0)

public final class ForwardingRule extends GeneratedMessageV3 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 load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.

Protobuf type google.cloud.compute.v1.ForwardingRule

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ForwardingRule

Implements

ForwardingRuleOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOW_GLOBAL_ACCESS_FIELD_NUMBER

public static final int ALLOW_GLOBAL_ACCESS_FIELD_NUMBER

Field Value
Type	Description
`int`

ALLOW_PSC_GLOBAL_ACCESS_FIELD_NUMBER

public static final int ALLOW_PSC_GLOBAL_ACCESS_FIELD_NUMBER

Field Value
Type	Description
`int`

ALL_PORTS_FIELD_NUMBER

public static final int ALL_PORTS_FIELD_NUMBER

Field Value
Type	Description
`int`

BACKEND_SERVICE_FIELD_NUMBER

public static final int BACKEND_SERVICE_FIELD_NUMBER

Field Value
Type	Description
`int`

BASE_FORWARDING_RULE_FIELD_NUMBER

public static final int BASE_FORWARDING_RULE_FIELD_NUMBER

Field Value
Type	Description
`int`

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER

Field Value
Type	Description
`int`

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

FINGERPRINT_FIELD_NUMBER

public static final int FINGERPRINT_FIELD_NUMBER

Field Value
Type	Description
`int`

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value
Type	Description
`int`

IP_COLLECTION_FIELD_NUMBER

public static final int IP_COLLECTION_FIELD_NUMBER

Field Value
Type	Description
`int`

IP_VERSION_FIELD_NUMBER

public static final int IP_VERSION_FIELD_NUMBER

Field Value
Type	Description
`int`

IS_MIRRORING_COLLECTOR_FIELD_NUMBER

public static final int IS_MIRRORING_COLLECTOR_FIELD_NUMBER

Field Value
Type	Description
`int`

I_P_ADDRESS_FIELD_NUMBER

public static final int I_P_ADDRESS_FIELD_NUMBER

Field Value
Type	Description
`int`

I_P_PROTOCOL_FIELD_NUMBER

public static final int I_P_PROTOCOL_FIELD_NUMBER

Field Value
Type	Description
`int`

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

Field Value
Type	Description
`int`

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value
Type	Description
`int`

LABEL_FINGERPRINT_FIELD_NUMBER

public static final int LABEL_FINGERPRINT_FIELD_NUMBER

Field Value
Type	Description
`int`

LOAD_BALANCING_SCHEME_FIELD_NUMBER

public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER

Field Value
Type	Description
`int`

METADATA_FILTERS_FIELD_NUMBER

public static final int METADATA_FILTERS_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER

Field Value
Type	Description
`int`

NETWORK_TIER_FIELD_NUMBER

public static final int NETWORK_TIER_FIELD_NUMBER

Field Value
Type	Description
`int`

NO_AUTOMATE_DNS_ZONE_FIELD_NUMBER

public static final int NO_AUTOMATE_DNS_ZONE_FIELD_NUMBER

Field Value
Type	Description
`int`

PORTS_FIELD_NUMBER

public static final int PORTS_FIELD_NUMBER

Field Value
Type	Description
`int`

PORT_RANGE_FIELD_NUMBER

public static final int PORT_RANGE_FIELD_NUMBER

Field Value
Type	Description
`int`

PSC_CONNECTION_ID_FIELD_NUMBER

public static final int PSC_CONNECTION_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

PSC_CONNECTION_STATUS_FIELD_NUMBER

public static final int PSC_CONNECTION_STATUS_FIELD_NUMBER

Field Value
Type	Description
`int`

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER

Field Value
Type	Description
`int`

SELF_LINK_FIELD_NUMBER

public static final int SELF_LINK_FIELD_NUMBER

Field Value
Type	Description
`int`

SERVICE_DIRECTORY_REGISTRATIONS_FIELD_NUMBER

public static final int SERVICE_DIRECTORY_REGISTRATIONS_FIELD_NUMBER

Field Value
Type	Description
`int`

SERVICE_LABEL_FIELD_NUMBER

public static final int SERVICE_LABEL_FIELD_NUMBER

Field Value
Type	Description
`int`

SERVICE_NAME_FIELD_NUMBER

public static final int SERVICE_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

SOURCE_IP_RANGES_FIELD_NUMBER

public static final int SOURCE_IP_RANGES_FIELD_NUMBER

Field Value
Type	Description
`int`

SUBNETWORK_FIELD_NUMBER

public static final int SUBNETWORK_FIELD_NUMBER

Field Value
Type	Description
`int`

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static ForwardingRule getDefaultInstance()

Returns
Type	Description
`ForwardingRule`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static ForwardingRule.Builder newBuilder()

Returns
Type	Description
`ForwardingRule.Builder`

newBuilder(ForwardingRule prototype)

public static ForwardingRule.Builder newBuilder(ForwardingRule prototype)

Parameter
Name	Description
`prototype`	`ForwardingRule`

Returns
Type	Description
`ForwardingRule.Builder`

parseDelimitedFrom(InputStream input)

public static ForwardingRule parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ForwardingRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static ForwardingRule parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ForwardingRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static ForwardingRule parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ForwardingRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static ForwardingRule parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ForwardingRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static ForwardingRule parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ForwardingRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static ForwardingRule parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ForwardingRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ForwardingRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<ForwardingRule> parser()

Returns
Type	Description
`Parser<ForwardingRule>`

Methods

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
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAllPorts()

public boolean getAllPorts()

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

optional bool all_ports = 445175796;

Returns
Type	Description
`boolean`	The allPorts.

getAllowGlobalAccess()

public boolean getAllowGlobalAccess()

If set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.

optional bool allow_global_access = 499409674;

Returns
Type	Description
`boolean`	The allowGlobalAccess.

getAllowPscGlobalAccess()

public boolean getAllowPscGlobalAccess()

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

optional bool allow_psc_global_access = 263471819;

Returns
Type	Description
`boolean`	The allowPscGlobalAccess.

getBackendService()

public String getBackendService()

Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types.

optional string backend_service = 306946058;

Returns
Type	Description
`String`	The backendService.

getBackendServiceBytes()

public ByteString getBackendServiceBytes()

Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types.

optional string backend_service = 306946058;

Returns
Type	Description
`ByteString`	The bytes for backendService.

getBaseForwardingRule()

public String getBaseForwardingRule()

[Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified.

optional string base_forwarding_rule = 524873104;

Returns
Type	Description
`String`	The baseForwardingRule.

getBaseForwardingRuleBytes()

public ByteString getBaseForwardingRuleBytes()

optional string base_forwarding_rule = 524873104;

Returns
Type	Description
`ByteString`	The bytes for baseForwardingRule.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
`String`	The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
`ByteString`	The bytes for creationTimestamp.

getDefaultInstanceForType()

public ForwardingRule getDefaultInstanceForType()

Returns
Type	Description
`ForwardingRule`

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type	Description
`ByteString`	The bytes for description.

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
Type	Description
`String`	The fingerprint.

getFingerprintBytes()

public ByteString getFingerprintBytes()

optional string fingerprint = 234678500;

Returns
Type	Description
`ByteString`	The bytes for fingerprint.

getIPAddress()

public String getIPAddress()

IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in 100.1.2.3 * IPv6 address range, as in 2600🔢:/96 * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see IP address specifications. When reading an IPAddress, the API always returns the IP address number.

optional string I_p_address = 42976943;

Returns
Type	Description
`String`	The iPAddress.

getIPAddressBytes()

public ByteString getIPAddressBytes()

optional string I_p_address = 42976943;

Returns
Type	Description
`ByteString`	The bytes for iPAddress.

getIPProtocol()

public String getIPProtocol()

The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in Load balancing features. Check the IPProtocolEnum enum for the list of possible values.

optional string I_p_protocol = 488094525;

Returns
Type	Description
`String`	The iPProtocol.

getIPProtocolBytes()

public ByteString getIPProtocolBytes()

optional string I_p_protocol = 488094525;

Returns
Type	Description
`ByteString`	The bytes for iPProtocol.

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
Type	Description
`long`	The id.

getIpCollection()

public String getIpCollection()

Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name

optional string ip_collection = 176818358;

Returns
Type	Description
`String`	The ipCollection.

getIpCollectionBytes()

public ByteString getIpCollectionBytes()

optional string ip_collection = 176818358;

Returns
Type	Description
`ByteString`	The bytes for ipCollection.

getIpVersion()

public String getIpVersion()

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
Type	Description
`String`	The ipVersion.

getIpVersionBytes()

public ByteString getIpVersionBytes()

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
Type	Description
`ByteString`	The bytes for ipVersion.

getIsMirroringCollector()

public boolean getIsMirroringCollector()

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

optional bool is_mirroring_collector = 119255164;

Returns
Type	Description
`boolean`	The isMirroringCollector.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
Type	Description
`String`	The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type	Description
`ByteString`	The bytes for kind.

getLabelFingerprint()

public String getLabelFingerprint()

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

optional string label_fingerprint = 178124825;

Returns
Type	Description
`String`	The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

optional string label_fingerprint = 178124825;

Returns
Type	Description
`ByteString`	The bytes for labelFingerprint.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public int getLabelsCount()

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

map<string, string> labels = 500195327;

Returns
Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

map<string, string> labels = 500195327;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

map<string, string> labels = 500195327;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

map<string, string> labels = 500195327;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getLoadBalancingScheme()

public String getLoadBalancingScheme()

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

optional string load_balancing_scheme = 363890244;

Returns
Type	Description
`String`	The loadBalancingScheme.

getLoadBalancingSchemeBytes()

public ByteString getLoadBalancingSchemeBytes()

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

optional string load_balancing_scheme = 363890244;

Returns
Type	Description
`ByteString`	The bytes for loadBalancingScheme.

getMetadataFilters(int index)

public MetadataFilter getMetadataFilters(int index)

Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`MetadataFilter`

getMetadataFiltersCount()

public int getMetadataFiltersCount()

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

Returns
Type	Description
`int`

getMetadataFiltersList()

public List<MetadataFilter> getMetadataFiltersList()

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

Returns
Type	Description
`List<MetadataFilter>`

getMetadataFiltersOrBuilder(int index)

public MetadataFilterOrBuilder getMetadataFiltersOrBuilder(int index)

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`MetadataFilterOrBuilder`

getMetadataFiltersOrBuilderList()

public List<? extends MetadataFilterOrBuilder> getMetadataFiltersOrBuilderList()

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

Returns
Type	Description
`List<? extends com.google.cloud.compute.v1.MetadataFilterOrBuilder>`

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
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

optional string name = 3373707;

Returns
Type	Description
`ByteString`	The bytes for name.

getNetwork()

public String getNetwork()

This field is not used for global external load balancing. For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

optional string network = 232872494;

Returns
Type	Description
`String`	The network.

getNetworkBytes()

public ByteString getNetworkBytes()

optional string network = 232872494;

Returns
Type	Description
`ByteString`	The bytes for network.

getNetworkTier()

public String getNetworkTier()

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Returns
Type	Description
`String`	The networkTier.

getNetworkTierBytes()

public ByteString getNetworkTierBytes()

optional string network_tier = 517397843;

Returns
Type	Description
`ByteString`	The bytes for networkTier.

getNoAutomateDnsZone()

public boolean getNoAutomateDnsZone()

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable.

optional bool no_automate_dns_zone = 64546991;

Returns
Type	Description
`boolean`	The noAutomateDnsZone.

getParserForType()

public Parser<ForwardingRule> getParserForType()

Returns
Type	Description
`Parser<ForwardingRule>`

Overrides

GeneratedMessageV3.getParserForType()

getPortRange()

public String getPortRange()

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

optional string port_range = 217518079;

Returns
Type	Description
`String`	The portRange.

getPortRangeBytes()

public ByteString getPortRangeBytes()

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

optional string port_range = 217518079;

Returns
Type	Description
`ByteString`	The bytes for portRange.

getPorts(int index)

public String getPorts(int index)

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The ports at the given index.

getPortsBytes(int index)

public ByteString getPortsBytes(int index)

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the ports at the given index.

getPortsCount()

public int getPortsCount()

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Returns
Type	Description
`int`	The count of ports.

getPortsList()

public ProtocolStringList getPortsList()

The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\d+(?:-\\d+)?

repeated string ports = 106854418;

Returns
Type	Description
`ProtocolStringList`	A list containing the ports.

getPscConnectionId()

public long getPscConnectionId()

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

optional uint64 psc_connection_id = 292082397;

Returns
Type	Description
`long`	The pscConnectionId.

getPscConnectionStatus()

public String getPscConnectionStatus()

Check the PscConnectionStatus enum for the list of possible values.

optional string psc_connection_status = 184149172;

Returns
Type	Description
`String`	The pscConnectionStatus.

getPscConnectionStatusBytes()

public ByteString getPscConnectionStatusBytes()

Check the PscConnectionStatus enum for the list of possible values.

optional string psc_connection_status = 184149172;

Returns
Type	Description
`ByteString`	The bytes for pscConnectionStatus.

getRegion()

public String getRegion()

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

optional string region = 138946292;

Returns
Type	Description
`String`	The region.

getRegionBytes()

public ByteString getRegionBytes()

optional string region = 138946292;

Returns
Type	Description
`ByteString`	The bytes for region.

getSelfLink()

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type	Description
`String`	The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type	Description
`ByteString`	The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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.