Package com.google.cloud.compute.v1
Class ForwardingRule
- 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 typegoogle.cloud.compute.v1.ForwardingRule
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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
getAllowPscGlobalAccess()
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.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
getBaseForwardingRule()
[Output Only] The URL for the corresponding base Forwarding Rule.com.google.protobuf.ByteString
getBaseForwardingRuleBytes()
[Output Only] The URL for the corresponding base Forwarding Rule.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
getSourceIpRanges(int index)
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.com.google.protobuf.ByteString
getSourceIpRangesBytes(int index)
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.int
getSourceIpRangesCount()
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.com.google.protobuf.ProtocolStringList
getSourceIpRangesList()
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.String
getSubnetwork()
This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.com.google.protobuf.ByteString
getSubnetworkBytes()
This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.String
getTarget()
The URL of the target resource to receive the matched traffic.com.google.protobuf.ByteString
getTargetBytes()
The URL of the target resource to receive the matched traffic.boolean
hasAllowGlobalAccess()
This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance.boolean
hasAllowPscGlobalAccess()
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.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
hasBaseForwardingRule()
[Output Only] The URL for the corresponding base Forwarding Rule.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(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 ForwardingRule
parseFrom(ByteBuffer data)
static ForwardingRule
parseFrom(ByteBuffer data, 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, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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
-
-
-
-
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
-
ALLOW_PSC_GLOBAL_ACCESS_FIELD_NUMBER
public static final int ALLOW_PSC_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
-
BASE_FORWARDING_RULE_FIELD_NUMBER
public static final int BASE_FORWARDING_RULE_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
-
SOURCE_IP_RANGES_FIELD_NUMBER
public static final int SOURCE_IP_RANGES_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 classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.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 interfaceForwardingRuleOrBuilder
- Returns:
- Whether the iPAddress field is set.
-
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: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:
getIPAddress
in interfaceForwardingRuleOrBuilder
- Returns:
- The iPAddress.
-
getIPAddressBytes
public com.google.protobuf.ByteString getIPAddressBytes()
IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number.
optional string I_p_address = 42976943;
- Specified by:
getIPAddressBytes
in interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy 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;
- Specified by:
hasAllowGlobalAccess
in interfaceForwardingRuleOrBuilder
- 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 set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy 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;
- Specified by:
getAllowGlobalAccess
in interfaceForwardingRuleOrBuilder
- Returns:
- The allowGlobalAccess.
-
hasAllowPscGlobalAccess
public boolean hasAllowPscGlobalAccess()
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;
- Specified by:
hasAllowPscGlobalAccess
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the allowPscGlobalAccess field is set.
-
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;
- Specified by:
getAllowPscGlobalAccess
in interfaceForwardingRuleOrBuilder
- Returns:
- The allowPscGlobalAccess.
-
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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for backendService.
-
hasBaseForwardingRule
public boolean hasBaseForwardingRule()
[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;
- Specified by:
hasBaseForwardingRule
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the baseForwardingRule field is set.
-
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;
- Specified by:
getBaseForwardingRule
in interfaceForwardingRuleOrBuilder
- Returns:
- The baseForwardingRule.
-
getBaseForwardingRuleBytes
public com.google.protobuf.ByteString getBaseForwardingRuleBytes()
[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;
- Specified by:
getBaseForwardingRuleBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for baseForwardingRule.
-
hasCreationTimestamp
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
- Specified by:
hasCreationTimestamp
in interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
-
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 interfaceForwardingRuleOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceForwardingRuleOrBuilder
-
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 interfaceForwardingRuleOrBuilder
-
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 interfaceForwardingRuleOrBuilder
-
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 interfaceForwardingRuleOrBuilder
-
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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- 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 interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for loadBalancingScheme.
-
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;
- Specified by:
getMetadataFiltersList
in interfaceForwardingRuleOrBuilder
-
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;
- Specified by:
getMetadataFiltersOrBuilderList
in interfaceForwardingRuleOrBuilder
-
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;
- Specified by:
getMetadataFiltersCount
in interfaceForwardingRuleOrBuilder
-
getMetadataFilters
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;
- Specified by:
getMetadataFilters
in interfaceForwardingRuleOrBuilder
-
getMetadataFiltersOrBuilder
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;
- Specified by:
getMetadataFiltersOrBuilder
in interfaceForwardingRuleOrBuilder
-
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]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.
optional string name = 3373707;
- Specified by:
hasName
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the name field is set.
-
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]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.
optional string name = 3373707;
- Specified by:
getName
in interfaceForwardingRuleOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.
optional string name = 3373707;
- Specified by:
getNameBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for name.
-
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 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;
- Specified by:
hasNetwork
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the network field is set.
-
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 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;
- Specified by:
getNetwork
in interfaceForwardingRuleOrBuilder
- Returns:
- The network.
-
getNetworkBytes
public com.google.protobuf.ByteString getNetworkBytes()
This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If 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;
- Specified by:
getNetworkBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for network.
-
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;
- Specified by:
hasNetworkTier
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the networkTier field is set.
-
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;
- Specified by:
getNetworkTier
in interfaceForwardingRuleOrBuilder
- Returns:
- The networkTier.
-
getNetworkTierBytes
public com.google.protobuf.ByteString getNetworkTierBytes()
This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. Check the NetworkTier enum for the list of possible values.
optional string network_tier = 517397843;
- Specified by:
getNetworkTierBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for networkTier.
-
hasNoAutomateDnsZone
public boolean hasNoAutomateDnsZone()
This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.
optional bool no_automate_dns_zone = 64546991;
- Specified by:
hasNoAutomateDnsZone
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the noAutomateDnsZone field is set.
-
getNoAutomateDnsZone
public boolean getNoAutomateDnsZone()
This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.
optional bool no_automate_dns_zone = 64546991;
- Specified by:
getNoAutomateDnsZone
in interfaceForwardingRuleOrBuilder
- Returns:
- The noAutomateDnsZone.
-
hasPortRange
public boolean hasPortRange()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
optional string port_range = 217518079;
- Specified by:
hasPortRange
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the portRange field is set.
-
getPortRange
public String getPortRange()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
optional string port_range = 217518079;
- Specified by:
getPortRange
in interfaceForwardingRuleOrBuilder
- Returns:
- The portRange.
-
getPortRangeBytes
public com.google.protobuf.ByteString getPortRangeBytes()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
optional string port_range = 217518079;
- Specified by:
getPortRangeBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for portRange.
-
getPortsList
public com.google.protobuf.ProtocolStringList getPortsList()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;
- Specified by:
getPortsList
in interfaceForwardingRuleOrBuilder
- Returns:
- A list containing the ports.
-
getPortsCount
public int getPortsCount()
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;
- Specified by:
getPortsCount
in interfaceForwardingRuleOrBuilder
- Returns:
- The count of ports.
-
getPorts
public String getPorts(int index)
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;
- Specified by:
getPorts
in interfaceForwardingRuleOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The ports at the given index.
-
getPortsBytes
public com.google.protobuf.ByteString getPortsBytes(int index)
This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;
- Specified by:
getPortsBytes
in interfaceForwardingRuleOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the ports at the given index.
-
hasPscConnectionId
public boolean hasPscConnectionId()
[Output Only] The PSC connection id of the PSC Forwarding Rule.
optional uint64 psc_connection_id = 292082397;
- Specified by:
hasPscConnectionId
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the pscConnectionId field is set.
-
getPscConnectionId
public long getPscConnectionId()
[Output Only] The PSC connection id of the PSC Forwarding Rule.
optional uint64 psc_connection_id = 292082397;
- Specified by:
getPscConnectionId
in interfaceForwardingRuleOrBuilder
- Returns:
- The pscConnectionId.
-
hasPscConnectionStatus
public boolean hasPscConnectionStatus()
Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;
- Specified by:
hasPscConnectionStatus
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the pscConnectionStatus field is set.
-
getPscConnectionStatus
public String getPscConnectionStatus()
Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;
- Specified by:
getPscConnectionStatus
in interfaceForwardingRuleOrBuilder
- Returns:
- The pscConnectionStatus.
-
getPscConnectionStatusBytes
public com.google.protobuf.ByteString getPscConnectionStatusBytes()
Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;
- Specified by:
getPscConnectionStatusBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for pscConnectionStatus.
-
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;
- Specified by:
hasRegion
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the region field is set.
-
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;
- Specified by:
getRegion
in interfaceForwardingRuleOrBuilder
- Returns:
- The region.
-
getRegionBytes
public com.google.protobuf.ByteString getRegionBytes()
[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
- Specified by:
getRegionBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for region.
-
hasSelfLink
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
- Specified by:
hasSelfLink
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the selfLink field is set.
-
getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
- Specified by:
getSelfLink
in interfaceForwardingRuleOrBuilder
- Returns:
- The selfLink.
-
getSelfLinkBytes
public com.google.protobuf.ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
- Specified by:
getSelfLinkBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for selfLink.
-
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;
- Specified by:
getServiceDirectoryRegistrationsList
in interfaceForwardingRuleOrBuilder
-
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;
- Specified by:
getServiceDirectoryRegistrationsOrBuilderList
in interfaceForwardingRuleOrBuilder
-
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;
- Specified by:
getServiceDirectoryRegistrationsCount
in interfaceForwardingRuleOrBuilder
-
getServiceDirectoryRegistrations
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;
- Specified by:
getServiceDirectoryRegistrations
in interfaceForwardingRuleOrBuilder
-
getServiceDirectoryRegistrationsOrBuilder
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;
- Specified by:
getServiceDirectoryRegistrationsOrBuilder
in interfaceForwardingRuleOrBuilder
-
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]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.
optional string service_label = 417008874;
- Specified by:
hasServiceLabel
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the serviceLabel field is set.
-
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]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.
optional string service_label = 417008874;
- Specified by:
getServiceLabel
in interfaceForwardingRuleOrBuilder
- Returns:
- The serviceLabel.
-
getServiceLabelBytes
public com.google.protobuf.ByteString getServiceLabelBytes()
An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.
optional string service_label = 417008874;
- Specified by:
getServiceLabelBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for serviceLabel.
-
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;
- Specified by:
hasServiceName
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the serviceName field is set.
-
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;
- Specified by:
getServiceName
in interfaceForwardingRuleOrBuilder
- Returns:
- The serviceName.
-
getServiceNameBytes
public com.google.protobuf.ByteString getServiceNameBytes()
[Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
optional string service_name = 359880149;
- Specified by:
getServiceNameBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for serviceName.
-
getSourceIpRangesList
public com.google.protobuf.ProtocolStringList getSourceIpRangesList()
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
repeated string source_ip_ranges = 111563210;
- Specified by:
getSourceIpRangesList
in interfaceForwardingRuleOrBuilder
- Returns:
- A list containing the sourceIpRanges.
-
getSourceIpRangesCount
public int getSourceIpRangesCount()
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
repeated string source_ip_ranges = 111563210;
- Specified by:
getSourceIpRangesCount
in interfaceForwardingRuleOrBuilder
- Returns:
- The count of sourceIpRanges.
-
getSourceIpRanges
public String getSourceIpRanges(int index)
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
repeated string source_ip_ranges = 111563210;
- Specified by:
getSourceIpRanges
in interfaceForwardingRuleOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The sourceIpRanges at the given index.
-
getSourceIpRangesBytes
public com.google.protobuf.ByteString getSourceIpRangesBytes(int index)
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
repeated string source_ip_ranges = 111563210;
- Specified by:
getSourceIpRangesBytes
in interfaceForwardingRuleOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the sourceIpRanges at the given index.
-
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;
- Specified by:
hasSubnetwork
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the subnetwork field is set.
-
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;
- Specified by:
getSubnetwork
in interfaceForwardingRuleOrBuilder
- Returns:
- The subnetwork.
-
getSubnetworkBytes
public com.google.protobuf.ByteString getSubnetworkBytes()
This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
optional string subnetwork = 307827694;
- Specified by:
getSubnetworkBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for subnetwork.
-
hasTarget
public boolean hasTarget()
The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
optional string target = 192835985;
- Specified by:
hasTarget
in interfaceForwardingRuleOrBuilder
- Returns:
- Whether the target field is set.
-
getTarget
public String getTarget()
The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
optional string target = 192835985;
- Specified by:
getTarget
in interfaceForwardingRuleOrBuilder
- Returns:
- The target.
-
getTargetBytes
public com.google.protobuf.ByteString getTargetBytes()
The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
optional string target = 192835985;
- Specified by:
getTargetBytes
in interfaceForwardingRuleOrBuilder
- Returns:
- The bytes for target.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ForwardingRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ForwardingRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ForwardingRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ForwardingRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ForwardingRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ForwardingRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ForwardingRule parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ForwardingRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ForwardingRule parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ForwardingRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static ForwardingRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ForwardingRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public ForwardingRule.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static ForwardingRule.Builder newBuilder()
-
newBuilder
public static ForwardingRule.Builder newBuilder(ForwardingRule prototype)
-
toBuilder
public ForwardingRule.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ForwardingRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static ForwardingRule getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<ForwardingRule> parser()
-
getParserForType
public com.google.protobuf.Parser<ForwardingRule> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public ForwardingRule getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-