Package com.google.cloud.compute.v1
Class ForwardingRule
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated
public final class ForwardingRule
extends com.google.protobuf.GeneratedMessage
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 load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.Protobuf type
google.cloud.compute.v1.ForwardingRule- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classRepresents a Forwarding Rule resource.static enumSpecifies the canary migration state for the backend buckets attached to this forwarding rule.static enumThe IP protocol to which this rule applies.static enumThe IP Version that will be used by this forwarding rule.static enumSpecifies the forwarding rule type.static enumThis signifies the networking tier used for configuring this load balancer and can only take the following values:PREMIUM, STANDARD.static enumNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) Labels for this resource.booleanbooleanIf set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions.booleanThis is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.booleanThe ports, portRange, and allPorts fields are mutually exclusive.Identifies the backend service to which the forwarding rule sends traffic.com.google.protobuf.ByteStringIdentifies the backend service to which the forwarding rule sends traffic.Output only.com.google.protobuf.ByteStringOutput only.Output only.com.google.protobuf.ByteStringOutput only.static ForwardingRuleAn optional description of this resource.com.google.protobuf.ByteStringAn optional description of this resource.static final com.google.protobuf.Descriptors.DescriptorSpecifies the canary migration state for the backend buckets attached to this forwarding rule.com.google.protobuf.ByteStringSpecifies the canary migration state for the backend buckets attached to this forwarding rule.floatDetermines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer.Fingerprint of this resource.com.google.protobuf.ByteStringFingerprint of this resource.longgetId()[Output Only] The unique identifier for the resource.IP address for which this forwarding rule accepts traffic.com.google.protobuf.ByteStringIP address for which this forwarding rule accepts traffic.Resource reference of a PublicDelegatedPrefix.com.google.protobuf.ByteStringResource reference of a PublicDelegatedPrefix.The IP protocol to which this rule applies.com.google.protobuf.ByteStringThe IP protocol to which this rule applies.The IP Version that will be used by this forwarding rule.com.google.protobuf.ByteStringThe IP Version that will be used by this forwarding rule.booleanIndicates whether or not this load balancer can be used as a collector for packet mirroring.getKind()Output only.com.google.protobuf.ByteStringOutput only.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.ByteStringA fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.Deprecated.intLabels for this resource.Labels for this resource.getLabelsOrDefault(String key, String defaultValue) Labels for this resource.getLabelsOrThrow(String key) Labels for this resource.Specifies the forwarding rule type.com.google.protobuf.ByteStringSpecifies the forwarding rule type.getMetadataFilters(int index) Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.intOpaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.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>Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.getName()Name of the resource; provided by the client when the resource is created.com.google.protobuf.ByteStringName of the resource; provided by the client when the resource is created.This field is not used for global external load balancing.com.google.protobuf.ByteStringThis field is not used for global external load balancing.This signifies the networking tier used for configuring this load balancer and can only take the following values:PREMIUM, STANDARD.com.google.protobuf.ByteStringThis signifies the networking tier used for configuring this load balancer and can only take the following values:PREMIUM, STANDARD.booleanThis 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>The ports, portRange, and allPorts fields are mutually exclusive.com.google.protobuf.ByteStringThe ports, portRange, and allPorts fields are mutually exclusive.getPorts(int index) The ports, portRange, and allPorts fields are mutually exclusive.com.google.protobuf.ByteStringgetPortsBytes(int index) The ports, portRange, and allPorts fields are mutually exclusive.intThe ports, portRange, and allPorts fields are mutually exclusive.com.google.protobuf.ProtocolStringListThe ports, portRange, and allPorts fields are mutually exclusive.long[Output Only] The PSC connection id of the PSC forwarding rule.Check the PscConnectionStatus enum for the list of possible values.com.google.protobuf.ByteStringCheck the PscConnectionStatus enum for the list of possible values.Output only.com.google.protobuf.ByteStringOutput only.[Output Only] Server-defined URL for the resource.com.google.protobuf.ByteString[Output Only] Server-defined URL for the resource.Output only.com.google.protobuf.ByteStringOutput only.intgetServiceDirectoryRegistrations(int index) Service Directory resources to register this forwarding rule with.intService Directory resources to register this forwarding rule with.Service Directory resources to register this forwarding rule with.getServiceDirectoryRegistrationsOrBuilder(int index) Service Directory resources to register this forwarding rule with.Service Directory resources to register this forwarding rule with.An optional prefix to the service name for this forwarding rule.com.google.protobuf.ByteStringAn optional prefix to the service name for this forwarding rule.[Output Only] The internal fully qualified service name for this forwarding rule.com.google.protobuf.ByteString[Output Only] The internal fully qualified service name for this forwarding rule.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.ByteStringgetSourceIpRangesBytes(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.intIf 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.ProtocolStringListIf 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.This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6.com.google.protobuf.ByteStringThis field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6.The URL of the target resource to receive the matched traffic.com.google.protobuf.ByteStringThe URL of the target resource to receive the matched traffic.booleanIf set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions.booleanThis is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.booleanThe ports, portRange, and allPorts fields are mutually exclusive.booleanIdentifies the backend service to which the forwarding rule sends traffic.booleanOutput only.booleanOutput only.booleanAn optional description of this resource.booleanSpecifies the canary migration state for the backend buckets attached to this forwarding rule.booleanDetermines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer.booleanFingerprint of this resource.inthashCode()booleanhasId()[Output Only] The unique identifier for the resource.booleanIP address for which this forwarding rule accepts traffic.booleanResource reference of a PublicDelegatedPrefix.booleanThe IP protocol to which this rule applies.booleanThe IP Version that will be used by this forwarding rule.booleanIndicates whether or not this load balancer can be used as a collector for packet mirroring.booleanhasKind()Output only.booleanA fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.booleanSpecifies the forwarding rule type.booleanhasName()Name of the resource; provided by the client when the resource is created.booleanThis field is not used for global external load balancing.booleanThis signifies the networking tier used for configuring this load balancer and can only take the following values:PREMIUM, STANDARD.booleanThis is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.booleanThe ports, portRange, and allPorts fields are mutually exclusive.boolean[Output Only] The PSC connection id of the PSC forwarding rule.booleanCheck the PscConnectionStatus enum for the list of possible values.booleanOutput only.boolean[Output Only] Server-defined URL for the resource.booleanOutput only.booleanAn optional prefix to the service name for this forwarding rule.boolean[Output Only] The internal fully qualified service name for this forwarding rule.booleanThis field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6.booleanThe URL of the target resource to receive the matched traffic.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic ForwardingRule.Builderstatic ForwardingRule.BuildernewBuilder(ForwardingRule prototype) protected ForwardingRule.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static ForwardingRuleparseDelimitedFrom(InputStream input) static ForwardingRuleparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ForwardingRuleparseFrom(byte[] data) static ForwardingRuleparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ForwardingRuleparseFrom(com.google.protobuf.ByteString data) static ForwardingRuleparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ForwardingRuleparseFrom(com.google.protobuf.CodedInputStream input) static ForwardingRuleparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ForwardingRuleparseFrom(InputStream input) static ForwardingRuleparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ForwardingRuleparseFrom(ByteBuffer data) static ForwardingRuleparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ForwardingRule>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
I_P_ADDRESS_FIELD_NUMBER
public static final int I_P_ADDRESS_FIELD_NUMBER- See Also:
-
I_P_PROTOCOL_FIELD_NUMBER
public static final int I_P_PROTOCOL_FIELD_NUMBER- See Also:
-
ALL_PORTS_FIELD_NUMBER
public static final int ALL_PORTS_FIELD_NUMBER- See Also:
-
ALLOW_GLOBAL_ACCESS_FIELD_NUMBER
public static final int ALLOW_GLOBAL_ACCESS_FIELD_NUMBER- See Also:
-
ALLOW_PSC_GLOBAL_ACCESS_FIELD_NUMBER
public static final int ALLOW_PSC_GLOBAL_ACCESS_FIELD_NUMBER- See Also:
-
BACKEND_SERVICE_FIELD_NUMBER
public static final int BACKEND_SERVICE_FIELD_NUMBER- See Also:
-
BASE_FORWARDING_RULE_FIELD_NUMBER
public static final int BASE_FORWARDING_RULE_FIELD_NUMBER- See Also:
-
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE_FIELD_NUMBER
public static final int EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE_FIELD_NUMBER- See Also:
-
EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_TESTING_PERCENTAGE_FIELD_NUMBER
public static final int EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_TESTING_PERCENTAGE_FIELD_NUMBER- See Also:
-
FINGERPRINT_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER- See Also:
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER- See Also:
-
IP_COLLECTION_FIELD_NUMBER
public static final int IP_COLLECTION_FIELD_NUMBER- See Also:
-
IP_VERSION_FIELD_NUMBER
public static final int IP_VERSION_FIELD_NUMBER- See Also:
-
IS_MIRRORING_COLLECTOR_FIELD_NUMBER
public static final int IS_MIRRORING_COLLECTOR_FIELD_NUMBER- See Also:
-
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER- See Also:
-
LABEL_FINGERPRINT_FIELD_NUMBER
public static final int LABEL_FINGERPRINT_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
LOAD_BALANCING_SCHEME_FIELD_NUMBER
public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER- See Also:
-
METADATA_FILTERS_FIELD_NUMBER
public static final int METADATA_FILTERS_FIELD_NUMBER- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER- See Also:
-
NETWORK_TIER_FIELD_NUMBER
public static final int NETWORK_TIER_FIELD_NUMBER- See Also:
-
NO_AUTOMATE_DNS_ZONE_FIELD_NUMBER
public static final int NO_AUTOMATE_DNS_ZONE_FIELD_NUMBER- See Also:
-
PORT_RANGE_FIELD_NUMBER
public static final int PORT_RANGE_FIELD_NUMBER- See Also:
-
PORTS_FIELD_NUMBER
public static final int PORTS_FIELD_NUMBER- See Also:
-
PSC_CONNECTION_ID_FIELD_NUMBER
public static final int PSC_CONNECTION_ID_FIELD_NUMBER- See Also:
-
PSC_CONNECTION_STATUS_FIELD_NUMBER
public static final int PSC_CONNECTION_STATUS_FIELD_NUMBER- See Also:
-
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER- See Also:
-
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER- See Also:
-
SELF_LINK_WITH_ID_FIELD_NUMBER
public static final int SELF_LINK_WITH_ID_FIELD_NUMBER- See Also:
-
SERVICE_DIRECTORY_REGISTRATIONS_FIELD_NUMBER
public static final int SERVICE_DIRECTORY_REGISTRATIONS_FIELD_NUMBER- See Also:
-
SERVICE_LABEL_FIELD_NUMBER
public static final int SERVICE_LABEL_FIELD_NUMBER- See Also:
-
SERVICE_NAME_FIELD_NUMBER
public static final int SERVICE_NAME_FIELD_NUMBER- See Also:
-
SOURCE_IP_RANGES_FIELD_NUMBER
public static final int SOURCE_IP_RANGES_FIELD_NUMBER- See Also:
-
SUBNETWORK_FIELD_NUMBER
public static final int SUBNETWORK_FIELD_NUMBER- See Also:
-
TARGET_FIELD_NUMBER
public static final int TARGET_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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 andvalidateForProxyless is set to true, theIPAddress 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 inhttps://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:
hasIPAddressin interfaceForwardingRuleOrBuilder- Returns:
- Whether the iPAddress field is set.
-
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 andvalidateForProxyless is set to true, theIPAddress 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 inhttps://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:
getIPAddressin 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 andvalidateForProxyless is set to true, theIPAddress 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 inhttps://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:
getIPAddressBytesin 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 andL3_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:
hasIPProtocolin interfaceForwardingRuleOrBuilder- Returns:
- Whether the iPProtocol field is set.
-
getIPProtocol
The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_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:
getIPProtocolin 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 andL3_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:
getIPProtocolBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for iPProtocol.
-
hasAllPorts
public boolean hasAllPorts()The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The allPorts field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
optional bool all_ports = 445175796;- Specified by:
hasAllPortsin interfaceForwardingRuleOrBuilder- Returns:
- Whether the allPorts field is set.
-
getAllPorts
public boolean getAllPorts()The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The allPorts field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
optional bool all_ports = 445175796;- Specified by:
getAllPortsin interfaceForwardingRuleOrBuilder- Returns:
- The allPorts.
-
hasAllowGlobalAccess
public boolean hasAllowGlobalAccess()If set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
optional bool allow_global_access = 499409674;- Specified by:
hasAllowGlobalAccessin interfaceForwardingRuleOrBuilder- Returns:
- Whether the allowGlobalAccess field is set.
-
getAllowGlobalAccess
public boolean getAllowGlobalAccess()If set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
optional bool allow_global_access = 499409674;- Specified by:
getAllowGlobalAccessin 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:
hasAllowPscGlobalAccessin 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:
getAllowPscGlobalAccessin interfaceForwardingRuleOrBuilder- Returns:
- The allowPscGlobalAccess.
-
hasBackendService
public boolean hasBackendService()Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types.
optional string backend_service = 306946058;- Specified by:
hasBackendServicein interfaceForwardingRuleOrBuilder- Returns:
- Whether the backendService field is set.
-
getBackendService
Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types.
optional string backend_service = 306946058;- Specified by:
getBackendServicein 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 and external passthrough Network Load Balancers; must be omitted for all other load balancer types.
optional string backend_service = 306946058;- Specified by:
getBackendServiceBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for backendService.
-
hasBaseForwardingRule
public boolean hasBaseForwardingRule()Output only. [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:
hasBaseForwardingRulein interfaceForwardingRuleOrBuilder- Returns:
- Whether the baseForwardingRule field is set.
-
getBaseForwardingRule
Output only. [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:
getBaseForwardingRulein interfaceForwardingRuleOrBuilder- Returns:
- The baseForwardingRule.
-
getBaseForwardingRuleBytes
public com.google.protobuf.ByteString getBaseForwardingRuleBytes()Output only. [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:
getBaseForwardingRuleBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for baseForwardingRule.
-
hasCreationTimestamp
public boolean hasCreationTimestamp()Output only. [Output Only] Creation timestamp inRFC3339 text format.
optional string creation_timestamp = 30525366;- Specified by:
hasCreationTimestampin interfaceForwardingRuleOrBuilder- Returns:
- Whether the creationTimestamp field is set.
-
getCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
optional string creation_timestamp = 30525366;- Specified by:
getCreationTimestampin interfaceForwardingRuleOrBuilder- Returns:
- The creationTimestamp.
-
getCreationTimestampBytes
public com.google.protobuf.ByteString getCreationTimestampBytes()Output only. [Output Only] Creation timestamp inRFC3339 text format.
optional string creation_timestamp = 30525366;- Specified by:
getCreationTimestampBytesin 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:
hasDescriptionin interfaceForwardingRuleOrBuilder- Returns:
- Whether the description field is set.
-
getDescription
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Specified by:
getDescriptionin 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:
getDescriptionBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for description.
-
hasExternalManagedBackendBucketMigrationState
public boolean hasExternalManagedBackendBucketMigrationState()Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Check the ExternalManagedBackendBucketMigrationState enum for the list of possible values.
optional string external_managed_backend_bucket_migration_state = 107811370;- Specified by:
hasExternalManagedBackendBucketMigrationStatein interfaceForwardingRuleOrBuilder- Returns:
- Whether the externalManagedBackendBucketMigrationState field is set.
-
getExternalManagedBackendBucketMigrationState
Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Check the ExternalManagedBackendBucketMigrationState enum for the list of possible values.
optional string external_managed_backend_bucket_migration_state = 107811370;- Specified by:
getExternalManagedBackendBucketMigrationStatein interfaceForwardingRuleOrBuilder- Returns:
- The externalManagedBackendBucketMigrationState.
-
getExternalManagedBackendBucketMigrationStateBytes
public com.google.protobuf.ByteString getExternalManagedBackendBucketMigrationStateBytes()Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Check the ExternalManagedBackendBucketMigrationState enum for the list of possible values.
optional string external_managed_backend_bucket_migration_state = 107811370;- Specified by:
getExternalManagedBackendBucketMigrationStateBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for externalManagedBackendBucketMigrationState.
-
hasExternalManagedBackendBucketMigrationTestingPercentage
public boolean hasExternalManagedBackendBucketMigrationTestingPercentage()Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.
optional float external_managed_backend_bucket_migration_testing_percentage = 105676592;- Specified by:
hasExternalManagedBackendBucketMigrationTestingPercentagein interfaceForwardingRuleOrBuilder- Returns:
- Whether the externalManagedBackendBucketMigrationTestingPercentage field is set.
-
getExternalManagedBackendBucketMigrationTestingPercentage
public float getExternalManagedBackendBucketMigrationTestingPercentage()Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.
optional float external_managed_backend_bucket_migration_testing_percentage = 105676592;- Specified by:
getExternalManagedBackendBucketMigrationTestingPercentagein interfaceForwardingRuleOrBuilder- Returns:
- The externalManagedBackendBucketMigrationTestingPercentage.
-
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:
hasFingerprintin interfaceForwardingRuleOrBuilder- Returns:
- Whether the fingerprint field is set.
-
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:
getFingerprintin 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:
getFingerprintBytesin 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:
hasIdin 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:
getIdin interfaceForwardingRuleOrBuilder- Returns:
- The id.
-
hasIpCollection
public boolean hasIpCollection()Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name
optional string ip_collection = 176818358;- Specified by:
hasIpCollectionin interfaceForwardingRuleOrBuilder- Returns:
- Whether the ipCollection field is set.
-
getIpCollection
Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name
optional string ip_collection = 176818358;- Specified by:
getIpCollectionin interfaceForwardingRuleOrBuilder- Returns:
- The ipCollection.
-
getIpCollectionBytes
public com.google.protobuf.ByteString getIpCollectionBytes()Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name
optional string ip_collection = 176818358;- Specified by:
getIpCollectionBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for ipCollection.
-
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:
hasIpVersionin interfaceForwardingRuleOrBuilder- Returns:
- Whether the ipVersion field is set.
-
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:
getIpVersionin 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:
getIpVersionBytesin 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 aPacketMirroring rule applies to them. This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
optional bool is_mirroring_collector = 119255164;- Specified by:
hasIsMirroringCollectorin 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 aPacketMirroring rule applies to them. This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
optional bool is_mirroring_collector = 119255164;- Specified by:
getIsMirroringCollectorin interfaceForwardingRuleOrBuilder- Returns:
- The isMirroringCollector.
-
hasKind
public boolean hasKind()Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
optional string kind = 3292052;- Specified by:
hasKindin interfaceForwardingRuleOrBuilder- Returns:
- Whether the kind field is set.
-
getKind
Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
optional string kind = 3292052;- Specified by:
getKindin interfaceForwardingRuleOrBuilder- Returns:
- The kind.
-
getKindBytes
public com.google.protobuf.ByteString getKindBytes()Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
optional string kind = 3292052;- Specified by:
getKindBytesin 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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
optional string label_fingerprint = 178124825;- Specified by:
hasLabelFingerprintin interfaceForwardingRuleOrBuilder- Returns:
- Whether the labelFingerprint field is set.
-
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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
optional string label_fingerprint = 178124825;- Specified by:
getLabelFingerprintin 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 error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
optional string label_fingerprint = 178124825;- Specified by:
getLabelFingerprintBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for labelFingerprint.
-
getLabelsCount
public int getLabelsCount()Description copied from interface:ForwardingRuleOrBuilderLabels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
map<string, string> labels = 500195327;- Specified by:
getLabelsCountin interfaceForwardingRuleOrBuilder
-
containsLabels
Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
map<string, string> labels = 500195327;- Specified by:
containsLabelsin interfaceForwardingRuleOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceForwardingRuleOrBuilder
-
getLabelsMap
Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
map<string, string> labels = 500195327;- Specified by:
getLabelsMapin interfaceForwardingRuleOrBuilder
-
getLabelsOrDefault
Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
map<string, string> labels = 500195327;- Specified by:
getLabelsOrDefaultin interfaceForwardingRuleOrBuilder
-
getLabelsOrThrow
Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
map<string, string> labels = 500195327;- Specified by:
getLabelsOrThrowin 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:
hasLoadBalancingSchemein interfaceForwardingRuleOrBuilder- Returns:
- Whether the loadBalancingScheme field is set.
-
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:
getLoadBalancingSchemein 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:
getLoadBalancingSchemeBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for loadBalancingScheme.
-
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 itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels 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 multiplemetadataFilters 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 thisForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;- Specified by:
getMetadataFiltersListin interfaceForwardingRuleOrBuilder
-
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 itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels 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 multiplemetadataFilters 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 thisForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;- Specified by:
getMetadataFiltersOrBuilderListin 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 itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels 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 multiplemetadataFilters 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 thisForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;- Specified by:
getMetadataFiltersCountin interfaceForwardingRuleOrBuilder
-
getMetadataFilters
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 itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels 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 multiplemetadataFilters 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 thisForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;- Specified by:
getMetadataFiltersin interfaceForwardingRuleOrBuilder
-
getMetadataFiltersOrBuilder
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 itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels 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 multiplemetadataFilters 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 thisForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;- Specified by:
getMetadataFiltersOrBuilderin 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 withRFC1035. 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:
hasNamein interfaceForwardingRuleOrBuilder- Returns:
- Whether the name field is set.
-
getName
Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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:
getNamein 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 withRFC1035. 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:
getNameBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for name.
-
hasNetwork
public boolean hasNetwork()This field is not used for global external load balancing. For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
optional string network = 232872494;- Specified by:
hasNetworkin interfaceForwardingRuleOrBuilder- Returns:
- Whether the network field is set.
-
getNetwork
This field is not used for global external load balancing. For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
optional string network = 232872494;- Specified by:
getNetworkin interfaceForwardingRuleOrBuilder- Returns:
- The network.
-
getNetworkBytes
public com.google.protobuf.ByteString getNetworkBytes()This field is not used for global external load balancing. For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
optional string network = 232872494;- Specified by:
getNetworkBytesin 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 andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM. 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:
hasNetworkTierin interfaceForwardingRuleOrBuilder- Returns:
- Whether the networkTier field is set.
-
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 andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM. 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:
getNetworkTierin 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 andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM. 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:
getNetworkTierBytesin 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. Once set, this field is not mutable.
optional bool no_automate_dns_zone = 64546991;- Specified by:
hasNoAutomateDnsZonein 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. Once set, this field is not mutable.
optional bool no_automate_dns_zone = 64546991;- Specified by:
getNoAutomateDnsZonein interfaceForwardingRuleOrBuilder- Returns:
- The noAutomateDnsZone.
-
hasPortRange
public boolean hasPortRange()The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges. 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:
hasPortRangein interfaceForwardingRuleOrBuilder- Returns:
- Whether the portRange field is set.
-
getPortRange
The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges. 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:
getPortRangein interfaceForwardingRuleOrBuilder- Returns:
- The portRange.
-
getPortRangeBytes
public com.google.protobuf.ByteString getPortRangeBytes()The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges. 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:
getPortRangeBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for portRange.
-
getPortsList
public com.google.protobuf.ProtocolStringList getPortsList()The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;- Specified by:
getPortsListin interfaceForwardingRuleOrBuilder- Returns:
- A list containing the ports.
-
getPortsCount
public int getPortsCount()The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;- Specified by:
getPortsCountin interfaceForwardingRuleOrBuilder- Returns:
- The count of ports.
-
getPorts
The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;- Specified by:
getPortsin 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) The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\d+(?:-\\d+)?
repeated string ports = 106854418;- Specified by:
getPortsBytesin 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:
hasPscConnectionIdin 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:
getPscConnectionIdin 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:
hasPscConnectionStatusin interfaceForwardingRuleOrBuilder- Returns:
- Whether the pscConnectionStatus field is set.
-
getPscConnectionStatus
Check the PscConnectionStatus enum for the list of possible values.
optional string psc_connection_status = 184149172;- Specified by:
getPscConnectionStatusin 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:
getPscConnectionStatusBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for pscConnectionStatus.
-
hasRegion
public boolean hasRegion()Output only. [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:
hasRegionin interfaceForwardingRuleOrBuilder- Returns:
- Whether the region field is set.
-
getRegion
Output only. [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:
getRegionin interfaceForwardingRuleOrBuilder- Returns:
- The region.
-
getRegionBytes
public com.google.protobuf.ByteString getRegionBytes()Output only. [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:
getRegionBytesin 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:
hasSelfLinkin interfaceForwardingRuleOrBuilder- Returns:
- Whether the selfLink field is set.
-
getSelfLink
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Specified by:
getSelfLinkin 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:
getSelfLinkBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for selfLink.
-
hasSelfLinkWithId
public boolean hasSelfLinkWithId()Output only. [Output Only] Server-defined URL for this resource with the resource id.
optional string self_link_with_id = 44520962;- Specified by:
hasSelfLinkWithIdin interfaceForwardingRuleOrBuilder- Returns:
- Whether the selfLinkWithId field is set.
-
getSelfLinkWithId
Output only. [Output Only] Server-defined URL for this resource with the resource id.
optional string self_link_with_id = 44520962;- Specified by:
getSelfLinkWithIdin interfaceForwardingRuleOrBuilder- Returns:
- The selfLinkWithId.
-
getSelfLinkWithIdBytes
public com.google.protobuf.ByteString getSelfLinkWithIdBytes()Output only. [Output Only] Server-defined URL for this resource with the resource id.
optional string self_link_with_id = 44520962;- Specified by:
getSelfLinkWithIdBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for selfLinkWithId.
-
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:
getServiceDirectoryRegistrationsListin 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:
getServiceDirectoryRegistrationsOrBuilderListin 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:
getServiceDirectoryRegistrationsCountin interfaceForwardingRuleOrBuilder
-
getServiceDirectoryRegistrations
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:
getServiceDirectoryRegistrationsin 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:
getServiceDirectoryRegistrationsOrBuilderin 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 withRFC1035. 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:
hasServiceLabelin interfaceForwardingRuleOrBuilder- Returns:
- Whether the serviceLabel field is set.
-
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 withRFC1035. 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:
getServiceLabelin 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 withRFC1035. 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:
getServiceLabelBytesin 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:
hasServiceNamein interfaceForwardingRuleOrBuilder- Returns:
- Whether the serviceName field is set.
-
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:
getServiceNamein 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:
getServiceNameBytesin 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 isEXTERNAL. 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:
getSourceIpRangesListin 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 isEXTERNAL. 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:
getSourceIpRangesCountin interfaceForwardingRuleOrBuilder- Returns:
- The count of sourceIpRanges.
-
getSourceIpRanges
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 isEXTERNAL. 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:
getSourceIpRangesin 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 isEXTERNAL. 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:
getSourceIpRangesBytesin 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 with internal load balancers and external passthrough Network Load Balancers 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:
hasSubnetworkin interfaceForwardingRuleOrBuilder- Returns:
- Whether the subnetwork field is set.
-
getSubnetwork
This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers 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:
getSubnetworkin 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 with internal load balancers and external passthrough Network Load Balancers 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:
getSubnetworkBytesin 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. The target is not mutable once set as a service attachment.
optional string target = 192835985;- Specified by:
hasTargetin interfaceForwardingRuleOrBuilder- Returns:
- Whether the target field is set.
-
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. The target is not mutable once set as a service attachment.
optional string target = 192835985;- Specified by:
getTargetin 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. The target is not mutable once set as a service attachment.
optional string target = 192835985;- Specified by:
getTargetBytesin interfaceForwardingRuleOrBuilder- Returns:
- The bytes for target.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein 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
- Throws:
IOException
-
parseFrom
public static ForwardingRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ForwardingRule.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-