ForwardingRuleOrBuilder (proto-google-cloud-compute-v1 1.78.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ForwardingRule, ForwardingRule.Builder
```
public interface ForwardingRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Labels for this resource.
`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.
`boolean`	`getAllowPscGlobalAccess()` This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
`boolean`	`getAllPorts()` The ports, portRange, and allPorts fields are mutually exclusive.
`String`	`getBackendService()` Identifies the backend service to which the forwarding rule sends traffic.
`com.google.protobuf.ByteString`	`getBackendServiceBytes()` Identifies the backend service to which the forwarding rule sends traffic.
`String`	`getBaseForwardingRule()` [Output Only] The URL for the corresponding base forwarding rule.
`com.google.protobuf.ByteString`	`getBaseForwardingRuleBytes()` [Output Only] The URL for the corresponding base forwarding rule.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`com.google.protobuf.ByteString`	`getCreationTimestampBytes()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` An optional description of this resource.
`String`	`getExternalManagedBackendBucketMigrationState()` Specifies the canary migration state for the backend buckets attached to this forwarding rule.
`com.google.protobuf.ByteString`	`getExternalManagedBackendBucketMigrationStateBytes()` Specifies the canary migration state for the backend buckets attached to this forwarding rule.
`float`	`getExternalManagedBackendBucketMigrationTestingPercentage()` Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer.
`String`	`getFingerprint()` Fingerprint of this resource.
`com.google.protobuf.ByteString`	`getFingerprintBytes()` Fingerprint of this resource.
`long`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getIPAddress()` IP address for which this forwarding rule accepts traffic.
`com.google.protobuf.ByteString`	`getIPAddressBytes()` IP address for which this forwarding rule accepts traffic.
`String`	`getIpCollection()` Resource reference of a PublicDelegatedPrefix.
`com.google.protobuf.ByteString`	`getIpCollectionBytes()` Resource reference of a PublicDelegatedPrefix.
`String`	`getIPProtocol()` The IP protocol to which this rule applies.
`com.google.protobuf.ByteString`	`getIPProtocolBytes()` The IP protocol to which this rule applies.
`String`	`getIpVersion()` The IP Version that will be used by this forwarding rule.
`com.google.protobuf.ByteString`	`getIpVersionBytes()` The IP Version that will be used by this forwarding rule.
`boolean`	`getIsMirroringCollector()` Indicates whether or not this load balancer can be used as a collector for packet mirroring.
`String`	`getKind()` [Output Only] Type of the resource.
`com.google.protobuf.ByteString`	`getKindBytes()` [Output Only] Type of the resource.
`String`	`getLabelFingerprint()` A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
`com.google.protobuf.ByteString`	`getLabelFingerprintBytes()` A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Labels for this resource.
`Map<String,String>`	`getLabelsMap()` Labels for this resource.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Labels for this resource.
`String`	`getLabelsOrThrow(String key)` Labels for this resource.
`String`	`getLoadBalancingScheme()` Specifies the forwarding rule type.
`com.google.protobuf.ByteString`	`getLoadBalancingSchemeBytes()` Specifies the forwarding rule type.
`MetadataFilter`	`getMetadataFilters(int index)` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`int`	`getMetadataFiltersCount()` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`List<MetadataFilter>`	`getMetadataFiltersList()` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`MetadataFilterOrBuilder`	`getMetadataFiltersOrBuilder(int index)` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`List<? extends MetadataFilterOrBuilder>`	`getMetadataFiltersOrBuilderList()` Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`String`	`getName()` Name of the resource; provided by the client when the resource is created.
`com.google.protobuf.ByteString`	`getNameBytes()` Name of the resource; provided by the client when the resource is created.
`String`	`getNetwork()` This field is not used for global external load balancing.
`com.google.protobuf.ByteString`	`getNetworkBytes()` This field is not used for global external load balancing.
`String`	`getNetworkTier()` This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
`com.google.protobuf.ByteString`	`getNetworkTierBytes()` This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
`boolean`	`getNoAutomateDnsZone()` This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
`String`	`getPortRange()` The ports, portRange, and allPorts fields are mutually exclusive.
`com.google.protobuf.ByteString`	`getPortRangeBytes()` The ports, portRange, and allPorts fields are mutually exclusive.
`String`	`getPorts(int index)` The ports, portRange, and allPorts fields are mutually exclusive.
`com.google.protobuf.ByteString`	`getPortsBytes(int index)` The ports, portRange, and allPorts fields are mutually exclusive.
`int`	`getPortsCount()` The ports, portRange, and allPorts fields are mutually exclusive.
`List<String>`	`getPortsList()` The ports, portRange, and allPorts fields are mutually exclusive.
`long`	`getPscConnectionId()` [Output Only] The PSC connection id of the PSC forwarding rule.
`String`	`getPscConnectionStatus()` Check the PscConnectionStatus enum for the list of possible values.
`com.google.protobuf.ByteString`	`getPscConnectionStatusBytes()` Check the PscConnectionStatus enum for the list of possible values.
`String`	`getRegion()` [Output Only] URL of the region where the regional forwarding rule resides.
`com.google.protobuf.ByteString`	`getRegionBytes()` [Output Only] URL of the region where the regional forwarding rule resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`com.google.protobuf.ByteString`	`getSelfLinkBytes()` [Output Only] Server-defined URL for the resource.
`String`	`getSelfLinkWithId()` [Output Only] Server-defined URL for this resource with the resource id.
`com.google.protobuf.ByteString`	`getSelfLinkWithIdBytes()` [Output Only] Server-defined URL for this resource with the resource id.
`ForwardingRuleServiceDirectoryRegistration`	`getServiceDirectoryRegistrations(int index)` Service Directory resources to register this forwarding rule with.
`int`	`getServiceDirectoryRegistrationsCount()` Service Directory resources to register this forwarding rule with.
`List<ForwardingRuleServiceDirectoryRegistration>`	`getServiceDirectoryRegistrationsList()` Service Directory resources to register this forwarding rule with.
`ForwardingRuleServiceDirectoryRegistrationOrBuilder`	`getServiceDirectoryRegistrationsOrBuilder(int index)` Service Directory resources to register this forwarding rule with.
`List<? extends ForwardingRuleServiceDirectoryRegistrationOrBuilder>`	`getServiceDirectoryRegistrationsOrBuilderList()` Service Directory resources to register this forwarding rule with.
`String`	`getServiceLabel()` An optional prefix to the service name for this forwarding rule.
`com.google.protobuf.ByteString`	`getServiceLabelBytes()` An optional prefix to the service name for this forwarding rule.
`String`	`getServiceName()` [Output Only] The internal fully qualified service name for this forwarding rule.
`com.google.protobuf.ByteString`	`getServiceNameBytes()` [Output Only] The internal fully qualified service name for this forwarding rule.
`String`	`getSourceIpRanges(int index)` If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.
`com.google.protobuf.ByteString`	`getSourceIpRangesBytes(int index)` If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.
`int`	`getSourceIpRangesCount()` If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.
`List<String>`	`getSourceIpRangesList()` If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.
`String`	`getSubnetwork()` This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6.
`com.google.protobuf.ByteString`	`getSubnetworkBytes()` This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6.
`String`	`getTarget()` The URL of the target resource to receive the matched traffic.
`com.google.protobuf.ByteString`	`getTargetBytes()` The URL of the target resource to receive the matched traffic.
`boolean`	`hasAllowGlobalAccess()` 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.
`boolean`	`hasAllowPscGlobalAccess()` This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
`boolean`	`hasAllPorts()` The ports, portRange, and allPorts fields are mutually exclusive.
`boolean`	`hasBackendService()` Identifies the backend service to which the forwarding rule sends traffic.
`boolean`	`hasBaseForwardingRule()` [Output Only] The URL for the corresponding base forwarding rule.
`boolean`	`hasCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`boolean`	`hasDescription()` An optional description of this resource.
`boolean`	`hasExternalManagedBackendBucketMigrationState()` Specifies the canary migration state for the backend buckets attached to this forwarding rule.
`boolean`	`hasExternalManagedBackendBucketMigrationTestingPercentage()` Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer.
`boolean`	`hasFingerprint()` Fingerprint of this resource.
`boolean`	`hasId()` [Output Only] The unique identifier for the resource.
`boolean`	`hasIPAddress()` IP address for which this forwarding rule accepts traffic.
`boolean`	`hasIpCollection()` Resource reference of a PublicDelegatedPrefix.
`boolean`	`hasIPProtocol()` The IP protocol to which this rule applies.
`boolean`	`hasIpVersion()` The IP Version that will be used by this forwarding rule.
`boolean`	`hasIsMirroringCollector()` Indicates whether or not this load balancer can be used as a collector for packet mirroring.
`boolean`	`hasKind()` [Output Only] Type of the resource.
`boolean`	`hasLabelFingerprint()` A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking.
`boolean`	`hasLoadBalancingScheme()` Specifies the forwarding rule type.
`boolean`	`hasName()` Name of the resource; provided by the client when the resource is created.
`boolean`	`hasNetwork()` This field is not used for global external load balancing.
`boolean`	`hasNetworkTier()` This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.
`boolean`	`hasNoAutomateDnsZone()` This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
`boolean`	`hasPortRange()` The ports, portRange, and allPorts fields are mutually exclusive.
`boolean`	`hasPscConnectionId()` [Output Only] The PSC connection id of the PSC forwarding rule.
`boolean`	`hasPscConnectionStatus()` Check the PscConnectionStatus enum for the list of possible values.
`boolean`	`hasRegion()` [Output Only] URL of the region where the regional forwarding rule resides.
`boolean`	`hasSelfLink()` [Output Only] Server-defined URL for the resource.
`boolean`	`hasSelfLinkWithId()` [Output Only] Server-defined URL for this resource with the resource id.
`boolean`	`hasServiceLabel()` An optional prefix to the service name for this forwarding rule.
`boolean`	`hasServiceName()` [Output Only] The internal fully qualified service name for this forwarding rule.
`boolean`	`hasSubnetwork()` This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6.
`boolean`	`hasTarget()` The URL of the target resource to receive the matched traffic.

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

hasIPAddress

boolean hasIPAddress()

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

optional string I_p_address = 42976943;

Returns:: Whether the iPAddress field is set.

getIPAddress

String getIPAddress()

optional string I_p_address = 42976943;

Returns:: The iPAddress.

getIPAddressBytes

com.google.protobuf.ByteString getIPAddressBytes()

optional string I_p_address = 42976943;

Returns:: The bytes for iPAddress.

hasIPProtocol

boolean hasIPProtocol()

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

optional string I_p_protocol = 488094525;

Returns:: Whether the iPProtocol field is set.

getIPProtocol

String getIPProtocol()

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

optional string I_p_protocol = 488094525;

Returns:: The iPProtocol.

getIPProtocolBytes

com.google.protobuf.ByteString getIPProtocolBytes()

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

optional string I_p_protocol = 488094525;

Returns:: The bytes for iPProtocol.

hasAllPorts

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 requires allPorts be set to true.

optional bool all_ports = 445175796;

Returns:: Whether the allPorts field is set.

getAllPorts

boolean getAllPorts()

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

optional bool all_ports = 445175796;

Returns:: The allPorts.

hasAllowGlobalAccess

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;

Returns:: Whether the allowGlobalAccess field is set.

getAllowGlobalAccess

boolean getAllowGlobalAccess()

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

optional bool allow_global_access = 499409674;

Returns:: The allowGlobalAccess.

hasAllowPscGlobalAccess

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;

Returns:: Whether the allowPscGlobalAccess field is set.

getAllowPscGlobalAccess

boolean getAllowPscGlobalAccess()

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

optional bool allow_psc_global_access = 263471819;

Returns:: The allowPscGlobalAccess.

hasBackendService

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;

Returns:: Whether the backendService field is set.

getBackendService

String getBackendService()

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

optional string backend_service = 306946058;

Returns:: The backendService.

getBackendServiceBytes

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;

Returns:: The bytes for backendService.

hasBaseForwardingRule

boolean hasBaseForwardingRule()

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

optional string base_forwarding_rule = 524873104;

Returns:: Whether the baseForwardingRule field is set.

getBaseForwardingRule

String getBaseForwardingRule()

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

optional string base_forwarding_rule = 524873104;

Returns:: The baseForwardingRule.

getBaseForwardingRuleBytes

com.google.protobuf.ByteString getBaseForwardingRuleBytes()

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

optional string base_forwarding_rule = 524873104;

Returns:: The bytes for baseForwardingRule.

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

Whether the creationTimestamp field is set.

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

The creationTimestamp.

getCreationTimestampBytes

com.google.protobuf.ByteString getCreationTimestampBytes()

 [Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns:: The bytes for creationTimestamp.

hasDescription

boolean hasDescription()

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

optional string description = 422937596;

Returns:: Whether the description field is set.

getDescription

String getDescription()

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

optional string description = 422937596;

Returns:: The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns:: The bytes for description.

hasExternalManagedBackendBucketMigrationState

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;

Returns:: Whether the externalManagedBackendBucketMigrationState field is set.

getExternalManagedBackendBucketMigrationState

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

Returns:: The externalManagedBackendBucketMigrationState.

getExternalManagedBackendBucketMigrationStateBytes

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;

Returns:: The bytes for externalManagedBackendBucketMigrationState.

hasExternalManagedBackendBucketMigrationTestingPercentage

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;

Returns:: Whether the externalManagedBackendBucketMigrationTestingPercentage field is set.

getExternalManagedBackendBucketMigrationTestingPercentage

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;

Returns:: The externalManagedBackendBucketMigrationTestingPercentage.

hasFingerprint

boolean hasFingerprint()

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

optional string fingerprint = 234678500;

Returns:: Whether the fingerprint field is set.

getFingerprint

String getFingerprint()

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

optional string fingerprint = 234678500;

Returns:: The fingerprint.

getFingerprintBytes

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;

Returns:: The bytes for fingerprint.

hasId

boolean hasId()

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

optional uint64 id = 3355;

Returns:: Whether the id field is set.

getId

long getId()

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

optional uint64 id = 3355;

Returns:: The id.

hasIpCollection

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 in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name

optional string ip_collection = 176818358;

Returns:: Whether the ipCollection field is set.

getIpCollection

String getIpCollection()

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

optional string ip_collection = 176818358;

Returns:: The ipCollection.

getIpCollectionBytes

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 in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name

optional string ip_collection = 176818358;

Returns:: The bytes for ipCollection.

hasIpVersion

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;

Returns:: Whether the ipVersion field is set.

getIpVersion

String getIpVersion()

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

optional string ip_version = 294959552;

Returns:: The ipVersion.

getIpVersionBytes

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;

Returns:: The bytes for ipVersion.

hasIsMirroringCollector

boolean hasIsMirroringCollector()

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

optional bool is_mirroring_collector = 119255164;

Returns:: Whether the isMirroringCollector field is set.

getIsMirroringCollector

boolean getIsMirroringCollector()

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

optional bool is_mirroring_collector = 119255164;

Returns:: The isMirroringCollector.

hasKind

boolean hasKind()

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

optional string kind = 3292052;

Returns:: Whether the kind field is set.

getKind

String getKind()

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

optional string kind = 3292052;

Returns:: The kind.

getKindBytes

com.google.protobuf.ByteString getKindBytes()

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

optional string kind = 3292052;

Returns:: The bytes for kind.

hasLabelFingerprint

boolean hasLabelFingerprint()

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

optional string label_fingerprint = 178124825;

Returns:: Whether the labelFingerprint field is set.

getLabelFingerprint

String getLabelFingerprint()

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

optional string label_fingerprint = 178124825;

Returns:: The labelFingerprint.

getLabelFingerprintBytes

com.google.protobuf.ByteString getLabelFingerprintBytes()

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

optional string label_fingerprint = 178124825;

Returns:: The bytes for labelFingerprint.

getLabelsCount

int getLabelsCount()

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

map<string, string> labels = 500195327;

containsLabels

boolean containsLabels(String key)

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

map<string, string> labels = 500195327;

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

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

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

map<string, string> labels = 500195327;

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

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

map<string, string> labels = 500195327;

getLabelsOrThrow

String getLabelsOrThrow(String key)

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

map<string, string> labels = 500195327;

hasLoadBalancingScheme

boolean hasLoadBalancingScheme()

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

optional string load_balancing_scheme = 363890244;

Returns:: Whether the loadBalancingScheme field is set.

getLoadBalancingScheme

String getLoadBalancingScheme()

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

optional string load_balancing_scheme = 363890244;

Returns:: The loadBalancingScheme.

getLoadBalancingSchemeBytes

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;

Returns:: The bytes for loadBalancingScheme.