ForwardingRule (proto-google-cloud-compute-v1 1.21.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.compute.v1.ForwardingRule

All Implemented Interfaces:: ForwardingRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ForwardingRule
extends com.google.protobuf.GeneratedMessageV3
implements ForwardingRuleOrBuilder

 Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules) 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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ForwardingRule.Builder` Represents a Forwarding Rule resource.
`static class`	`ForwardingRule.IPProtocolEnum` The IP protocol to which this rule applies.
`static class`	`ForwardingRule.IpVersion` The IP Version that will be used by this forwarding rule.
`static class`	`ForwardingRule.LoadBalancingScheme` Specifies the forwarding rule type.
`static class`	`ForwardingRule.NetworkTier` This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
`static class`	`ForwardingRule.PscConnectionStatus`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_PORTS_FIELD_NUMBER`
`static int`	`ALLOW_GLOBAL_ACCESS_FIELD_NUMBER`
`static int`	`BACKEND_SERVICE_FIELD_NUMBER`
`static int`	`CREATION_TIMESTAMP_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`FINGERPRINT_FIELD_NUMBER`
`static int`	`I_P_ADDRESS_FIELD_NUMBER`
`static int`	`I_P_PROTOCOL_FIELD_NUMBER`
`static int`	`ID_FIELD_NUMBER`
`static int`	`IP_VERSION_FIELD_NUMBER`
`static int`	`IS_MIRRORING_COLLECTOR_FIELD_NUMBER`
`static int`	`KIND_FIELD_NUMBER`
`static int`	`LABEL_FINGERPRINT_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`LOAD_BALANCING_SCHEME_FIELD_NUMBER`
`static int`	`METADATA_FILTERS_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`NETWORK_FIELD_NUMBER`
`static int`	`NETWORK_TIER_FIELD_NUMBER`
`static int`	`NO_AUTOMATE_DNS_ZONE_FIELD_NUMBER`
`static int`	`PORT_RANGE_FIELD_NUMBER`
`static int`	`PORTS_FIELD_NUMBER`
`static int`	`PSC_CONNECTION_ID_FIELD_NUMBER`
`static int`	`PSC_CONNECTION_STATUS_FIELD_NUMBER`
`static int`	`REGION_FIELD_NUMBER`
`static int`	`SELF_LINK_FIELD_NUMBER`
`static int`	`SERVICE_DIRECTORY_REGISTRATIONS_FIELD_NUMBER`
`static int`	`SERVICE_LABEL_FIELD_NUMBER`
`static int`	`SERVICE_NAME_FIELD_NUMBER`
`static int`	`SUBNETWORK_FIELD_NUMBER`
`static int`	`TARGET_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Labels for this resource.
`boolean`	`equals(Object obj)`
`boolean`	`getAllowGlobalAccess()` This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
`boolean`	`getAllPorts()` This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
`String`	`getBackendService()` Identifies the backend service to which the forwarding rule sends traffic.
`com.google.protobuf.ByteString`	`getBackendServiceBytes()` Identifies the backend service to which the forwarding rule sends traffic.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`com.google.protobuf.ByteString`	`getCreationTimestampBytes()` [Output Only] Creation timestamp in RFC3339 text format.
`static ForwardingRule`	`getDefaultInstance()`
`ForwardingRule`	`getDefaultInstanceForType()`
`String`	`getDescription()` An optional description of this resource.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` An optional description of this resource.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getFingerprint()` Fingerprint of this resource.
`com.google.protobuf.ByteString`	`getFingerprintBytes()` Fingerprint of this resource.
`long`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getIPAddress()` IP address for which this forwarding rule accepts traffic.
`com.google.protobuf.ByteString`	`getIPAddressBytes()` IP address for which this forwarding rule accepts traffic.
`String`	`getIPProtocol()` The IP protocol to which this rule applies.
`com.google.protobuf.ByteString`	`getIPProtocolBytes()` The IP protocol to which this rule applies.
`String`	`getIpVersion()` The IP Version that will be used by this forwarding rule.
`com.google.protobuf.ByteString`	`getIpVersionBytes()` The IP Version that will be used by this forwarding rule.
`boolean`	`getIsMirroringCollector()` Indicates whether or not this load balancer can be used as a collector for packet mirroring.
`String`	`getKind()` [Output Only] Type of the resource.
`com.google.protobuf.ByteString`	`getKindBytes()` [Output Only] Type of the resource.
`String`	`getLabelFingerprint()` A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
`com.google.protobuf.ByteString`	`getLabelFingerprintBytes()` A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Labels for this resource.
`Map<String,String>`	`getLabelsMap()` Labels for this resource.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Labels for this resource.
`String`	`getLabelsOrThrow(String key)` Labels for this resource.
`String`	`getLoadBalancingScheme()` Specifies the forwarding rule type.
`com.google.protobuf.ByteString`	`getLoadBalancingSchemeBytes()` Specifies the forwarding rule type.
`MetadataFilter`	`getMetadataFilters(int index)` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`int`	`getMetadataFiltersCount()` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`List<MetadataFilter>`	`getMetadataFiltersList()` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`MetadataFilterOrBuilder`	`getMetadataFiltersOrBuilder(int index)` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`List<? extends MetadataFilterOrBuilder>`	`getMetadataFiltersOrBuilderList()` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`String`	`getName()` Name of the resource; provided by the client when the resource is created.
`com.google.protobuf.ByteString`	`getNameBytes()` Name of the resource; provided by the client when the resource is created.
`String`	`getNetwork()` This field is not used for external load balancing.
`com.google.protobuf.ByteString`	`getNetworkBytes()` This field is not used for external load balancing.
`String`	`getNetworkTier()` This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
`com.google.protobuf.ByteString`	`getNetworkTierBytes()` This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
`boolean`	`getNoAutomateDnsZone()` This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
`com.google.protobuf.Parser<ForwardingRule>`	`getParserForType()`
`String`	`getPortRange()` This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
`com.google.protobuf.ByteString`	`getPortRangeBytes()` This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
`String`	`getPorts(int index)` This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
`com.google.protobuf.ByteString`	`getPortsBytes(int index)` This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
`int`	`getPortsCount()` This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
`com.google.protobuf.ProtocolStringList`	`getPortsList()` This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
`long`	`getPscConnectionId()` [Output Only] The PSC connection id of the PSC Forwarding Rule.
`String`	`getPscConnectionStatus()` Check the PscConnectionStatus enum for the list of possible values.
`com.google.protobuf.ByteString`	`getPscConnectionStatusBytes()` Check the PscConnectionStatus enum for the list of possible values.
`String`	`getRegion()` [Output Only] URL of the region where the regional forwarding rule resides.
`com.google.protobuf.ByteString`	`getRegionBytes()` [Output Only] URL of the region where the regional forwarding rule resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`com.google.protobuf.ByteString`	`getSelfLinkBytes()` [Output Only] Server-defined URL for the resource.
`int`	`getSerializedSize()`
`ForwardingRuleServiceDirectoryRegistration`	`getServiceDirectoryRegistrations(int index)` Service Directory resources to register this forwarding rule with.
`int`	`getServiceDirectoryRegistrationsCount()` Service Directory resources to register this forwarding rule with.
`List<ForwardingRuleServiceDirectoryRegistration>`	`getServiceDirectoryRegistrationsList()` Service Directory resources to register this forwarding rule with.
`ForwardingRuleServiceDirectoryRegistrationOrBuilder`	`getServiceDirectoryRegistrationsOrBuilder(int index)` Service Directory resources to register this forwarding rule with.
`List<? extends ForwardingRuleServiceDirectoryRegistrationOrBuilder>`	`getServiceDirectoryRegistrationsOrBuilderList()` Service Directory resources to register this forwarding rule with.
`String`	`getServiceLabel()` An optional prefix to the service name for this Forwarding Rule.
`com.google.protobuf.ByteString`	`getServiceLabelBytes()` An optional prefix to the service name for this Forwarding Rule.
`String`	`getServiceName()` [Output Only] The internal fully qualified service name for this Forwarding Rule.
`com.google.protobuf.ByteString`	`getServiceNameBytes()` [Output Only] The internal fully qualified service name for this Forwarding Rule.
`String`	`getSubnetwork()` This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.
`com.google.protobuf.ByteString`	`getSubnetworkBytes()` This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.
`String`	`getTarget()` The URL of the target resource to receive the matched traffic.
`com.google.protobuf.ByteString`	`getTargetBytes()` The URL of the target resource to receive the matched traffic.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasAllowGlobalAccess()` This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.
`boolean`	`hasAllPorts()` This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
`boolean`	`hasBackendService()` Identifies the backend service to which the forwarding rule sends traffic.
`boolean`	`hasCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`boolean`	`hasDescription()` An optional description of this resource.
`boolean`	`hasFingerprint()` Fingerprint of this resource.
`int`	`hashCode()`
`boolean`	`hasId()` [Output Only] The unique identifier for the resource.
`boolean`	`hasIPAddress()` IP address for which this forwarding rule accepts traffic.
`boolean`	`hasIPProtocol()` The IP protocol to which this rule applies.
`boolean`	`hasIpVersion()` The IP Version that will be used by this forwarding rule.
`boolean`	`hasIsMirroringCollector()` Indicates whether or not this load balancer can be used as a collector for packet mirroring.
`boolean`	`hasKind()` [Output Only] Type of the resource.
`boolean`	`hasLabelFingerprint()` A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
`boolean`	`hasLoadBalancingScheme()` Specifies the forwarding rule type.
`boolean`	`hasName()` Name of the resource; provided by the client when the resource is created.
`boolean`	`hasNetwork()` This field is not used for external load balancing.
`boolean`	`hasNetworkTier()` This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
`boolean`	`hasNoAutomateDnsZone()` This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
`boolean`	`hasPortRange()` This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP.
`boolean`	`hasPscConnectionId()` [Output Only] The PSC connection id of the PSC Forwarding Rule.
`boolean`	`hasPscConnectionStatus()` Check the PscConnectionStatus enum for the list of possible values.
`boolean`	`hasRegion()` [Output Only] URL of the region where the regional forwarding rule resides.
`boolean`	`hasSelfLink()` [Output Only] Server-defined URL for the resource.
`boolean`	`hasServiceLabel()` An optional prefix to the service name for this Forwarding Rule.
`boolean`	`hasServiceName()` [Output Only] The internal fully qualified service name for this Forwarding Rule.
`boolean`	`hasSubnetwork()` This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.
`boolean`	`hasTarget()` The URL of the target resource to receive the matched traffic.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static ForwardingRule.Builder`	`newBuilder()`
`static ForwardingRule.Builder`	`newBuilder(ForwardingRule prototype)`
`ForwardingRule.Builder`	`newBuilderForType()`
`protected ForwardingRule.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static ForwardingRule`	`parseDelimitedFrom(InputStream input)`
`static ForwardingRule`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ForwardingRule`	`parseFrom(byte[] data)`
`static ForwardingRule`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ForwardingRule`	`parseFrom(ByteBuffer data)`
`static ForwardingRule`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ForwardingRule`	`parseFrom(com.google.protobuf.ByteString data)`
`static ForwardingRule`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ForwardingRule`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static ForwardingRule`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ForwardingRule`	`parseFrom(InputStream input)`
`static ForwardingRule`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<ForwardingRule>`	`parser()`
`ForwardingRule.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- I_P_ADDRESS_FIELD_NUMBER
```
public static final int I_P_ADDRESS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- I_P_PROTOCOL_FIELD_NUMBER
```
public static final int I_P_PROTOCOL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALL_PORTS_FIELD_NUMBER
```
public static final int ALL_PORTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALLOW_GLOBAL_ACCESS_FIELD_NUMBER
```
public static final int ALLOW_GLOBAL_ACCESS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BACKEND_SERVICE_FIELD_NUMBER
```
public static final int BACKEND_SERVICE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATION_TIMESTAMP_FIELD_NUMBER
```
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FINGERPRINT_FIELD_NUMBER
```
public static final int FINGERPRINT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ID_FIELD_NUMBER
```
public static final int ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IP_VERSION_FIELD_NUMBER
```
public static final int IP_VERSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IS_MIRRORING_COLLECTOR_FIELD_NUMBER
```
public static final int IS_MIRRORING_COLLECTOR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- KIND_FIELD_NUMBER
```
public static final int KIND_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABEL_FINGERPRINT_FIELD_NUMBER
```
public static final int LABEL_FINGERPRINT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LOAD_BALANCING_SCHEME_FIELD_NUMBER
```
public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METADATA_FILTERS_FIELD_NUMBER
```
public static final int METADATA_FILTERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NETWORK_FIELD_NUMBER
```
public static final int NETWORK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NETWORK_TIER_FIELD_NUMBER
```
public static final int NETWORK_TIER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NO_AUTOMATE_DNS_ZONE_FIELD_NUMBER
```
public static final int NO_AUTOMATE_DNS_ZONE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PORT_RANGE_FIELD_NUMBER
```
public static final int PORT_RANGE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PORTS_FIELD_NUMBER
```
public static final int PORTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PSC_CONNECTION_ID_FIELD_NUMBER
```
public static final int PSC_CONNECTION_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PSC_CONNECTION_STATUS_FIELD_NUMBER
```
public static final int PSC_CONNECTION_STATUS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REGION_FIELD_NUMBER
```
public static final int REGION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SELF_LINK_FIELD_NUMBER
```
public static final int SELF_LINK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SERVICE_DIRECTORY_REGISTRATIONS_FIELD_NUMBER
```
public static final int SERVICE_DIRECTORY_REGISTRATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SERVICE_LABEL_FIELD_NUMBER
```
public static final int SERVICE_LABEL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SERVICE_NAME_FIELD_NUMBER
```
public static final int SERVICE_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SUBNETWORK_FIELD_NUMBER
```
public static final int SUBNETWORK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TARGET_FIELD_NUMBER
```
public static final int TARGET_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasIPAddress

public boolean hasIPAddress()

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

optional string I_p_address = 42976943;

Specified by:: hasIPAddress in interface ForwardingRuleOrBuilder
Returns:: Whether the iPAddress field is set.

getIPAddress

public String getIPAddress()

optional string I_p_address = 42976943;

Specified by:: getIPAddress in interface ForwardingRuleOrBuilder
Returns:: The iPAddress.

getIPAddressBytes

public com.google.protobuf.ByteString getIPAddressBytes()

optional string I_p_address = 42976943;

Specified by:: getIPAddressBytes in interface ForwardingRuleOrBuilder
Returns:: The bytes for iPAddress.

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](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
 Check the IPProtocolEnum enum for the list of possible values.

optional string I_p_protocol = 488094525;

Specified by:: hasIPProtocol in interface ForwardingRuleOrBuilder
Returns:: Whether the iPProtocol field is set.

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](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
 Check the IPProtocolEnum enum for the list of possible values.

optional string I_p_protocol = 488094525;

Specified by:: getIPProtocol in interface ForwardingRuleOrBuilder
Returns:: The iPProtocol.

getIPProtocolBytes

public com.google.protobuf.ByteString getIPProtocolBytes()

 The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
 Check the IPProtocolEnum enum for the list of possible values.

optional string I_p_protocol = 488094525;

Specified by:: getIPProtocolBytes in interface ForwardingRuleOrBuilder
Returns:: The bytes for iPProtocol.

hasAllPorts

public boolean hasAllPorts()

 This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.

optional bool all_ports = 445175796;

Specified by:: hasAllPorts in interface ForwardingRuleOrBuilder
Returns:: Whether the allPorts field is set.

getAllPorts

public boolean getAllPorts()

 This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.

optional bool all_ports = 445175796;

Specified by:: getAllPorts in interface ForwardingRuleOrBuilder
Returns:: The allPorts.

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;

Specified by:: hasAllowGlobalAccess in interface ForwardingRuleOrBuilder
Returns:: Whether the allowGlobalAccess field is set.

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;

Specified by:: getAllowGlobalAccess in interface ForwardingRuleOrBuilder
Returns:: The allowGlobalAccess.

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;

Specified by:: hasBackendService in interface ForwardingRuleOrBuilder
Returns:: Whether the backendService field is set.

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;

Specified by:: getBackendService in interface ForwardingRuleOrBuilder
Returns:: The backendService.

getBackendServiceBytes

public com.google.protobuf.ByteString getBackendServiceBytes()

 Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

optional string backend_service = 306946058;

Specified by:: getBackendServiceBytes in interface ForwardingRuleOrBuilder
Returns:: The bytes for backendService.

hasCreationTimestamp
```
public boolean hasCreationTimestamp()
```
```
 [Output Only] Creation timestamp in RFC3339 text format.
 
```
optional string creation_timestamp = 30525366;
Specified by:

hasCreationTimestamp in interface ForwardingRuleOrBuilder

Returns:

Whether the creationTimestamp field is set.

getCreationTimestamp
```
public String getCreationTimestamp()
```
```
 [Output Only] Creation timestamp in RFC3339 text format.
 
```
optional string creation_timestamp = 30525366;
Specified by:

getCreationTimestamp in interface ForwardingRuleOrBuilder

Returns:

The creationTimestamp.

getCreationTimestampBytes
```
public com.google.protobuf.ByteString getCreationTimestampBytes()
```
```
 [Output Only] Creation timestamp in RFC3339 text format.
 
```
optional string creation_timestamp = 30525366;
Specified by:

getCreationTimestampBytes in interface ForwardingRuleOrBuilder

Returns:

The bytes for creationTimestamp.

hasDescription
```
public boolean hasDescription()
```
```
 An optional description of this resource. Provide this property when you create the resource.
 
```
optional string description = 422937596;
Specified by:

hasDescription in interface ForwardingRuleOrBuilder

Returns:

Whether the description field is set.

getDescription
```
public String getDescription()
```
```
 An optional description of this resource. Provide this property when you create the resource.
 
```
optional string description = 422937596;
Specified by:

getDescription in interface ForwardingRuleOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

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

optional string description = 422937596;

Specified by:: getDescriptionBytes in interface ForwardingRuleOrBuilder
Returns:: The bytes for description.

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;

Specified by:: hasFingerprint in interface ForwardingRuleOrBuilder
Returns:: Whether the fingerprint field is set.

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;

Specified by:: getFingerprint in interface ForwardingRuleOrBuilder
Returns:: The fingerprint.

getFingerprintBytes

public com.google.protobuf.ByteString getFingerprintBytes()

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

optional string fingerprint = 234678500;

Specified by:: getFingerprintBytes in interface ForwardingRuleOrBuilder
Returns:: The bytes for fingerprint.

hasId

public boolean hasId()

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

optional uint64 id = 3355;

Specified by:: hasId in interface ForwardingRuleOrBuilder
Returns:: Whether the id field is set.

getId

public long getId()

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

optional uint64 id = 3355;

Specified by:: getId in interface ForwardingRuleOrBuilder
Returns:: The id.

hasIpVersion

public boolean hasIpVersion()

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

optional string ip_version = 294959552;

Specified by:: hasIpVersion in interface ForwardingRuleOrBuilder
Returns:: Whether the ipVersion field is set.

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;

Specified by:: getIpVersion in interface ForwardingRuleOrBuilder
Returns:: The ipVersion.

getIpVersionBytes

public com.google.protobuf.ByteString getIpVersionBytes()

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

optional string ip_version = 294959552;

Specified by:: getIpVersionBytes in interface ForwardingRuleOrBuilder
Returns:: The bytes for ipVersion.

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;

Specified by:: hasIsMirroringCollector in interface ForwardingRuleOrBuilder
Returns:: Whether the isMirroringCollector field is set.

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;

Specified by:: getIsMirroringCollector in interface ForwardingRuleOrBuilder
Returns:: The isMirroringCollector.

hasKind
```
public boolean hasKind()
```
```
 [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
 
```
optional string kind = 3292052;
Specified by:

hasKind in interface ForwardingRuleOrBuilder

Returns:

Whether the kind field is set.

getKind

public String getKind()

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

optional string kind = 3292052;

Specified by:: getKind in interface ForwardingRuleOrBuilder
Returns:: The kind.

getKindBytes

public com.google.protobuf.ByteString getKindBytes()

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

optional string kind = 3292052;

Specified by:: getKindBytes in interface ForwardingRuleOrBuilder
Returns:: The bytes for kind.

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;

Specified by:: hasLabelFingerprint in interface ForwardingRuleOrBuilder
Returns:: Whether the labelFingerprint field is set.

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;

Specified by:: getLabelFingerprint in interface ForwardingRuleOrBuilder
Returns:: The labelFingerprint.

getLabelFingerprintBytes

public com.google.protobuf.ByteString getLabelFingerprintBytes()

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

optional string label_fingerprint = 178124825;

Specified by:: getLabelFingerprintBytes in interface ForwardingRuleOrBuilder
Returns:: The bytes for labelFingerprint.

getLabelsCount

public int getLabelsCount()

Description copied from interface: ForwardingRuleOrBuilder

 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;

Specified by:: getLabelsCount in interface ForwardingRuleOrBuilder

containsLabels

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;

Specified by:: containsLabels in interface ForwardingRuleOrBuilder

getLabels
```
@Deprecated
public Map<String,String> getLabels()
```
Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface ForwardingRuleOrBuilder

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;

Specified by:: getLabelsMap in interface ForwardingRuleOrBuilder

getLabelsOrDefault

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;

Specified by:: getLabelsOrDefault in interface ForwardingRuleOrBuilder

getLabelsOrThrow

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;

Specified by:: getLabelsOrThrow in interface ForwardingRuleOrBuilder

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;

Specified by:: hasLoadBalancingScheme in interface ForwardingRuleOrBuilder
Returns:: Whether the loadBalancingScheme field is set.

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;

Specified by:: getLoadBalancingScheme in interface ForwardingRuleOrBuilder
Returns:: The loadBalancingScheme.

getLoadBalancingSchemeBytes

public com.google.protobuf.ByteString getLoadBalancingSchemeBytes()

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

optional string load_balancing_scheme = 363890244;

Specified by:: getLoadBalancingSchemeBytes in interface ForwardingRuleOrBuilder
Returns:: The bytes for loadBalancingScheme.