Interface ForwardingRuleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ForwardingRule, ForwardingRule.Builder

@Generated public interface ForwardingRuleOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • 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 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;
      Returns:
      Whether the iPAddress field is set.
    • getIPAddress

      String getIPAddress()
       IP address for which this forwarding rule accepts traffic. When a client
       sends traffic to this IP address, the forwarding rule directs the traffic
       to the referenced target or backendService.
       While creating a forwarding rule, specifying an IPAddress is
       required under the following circumstances:
      
      
       - When the target is set to targetGrpcProxy 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;
      Returns:
      The iPAddress.
    • getIPAddressBytes

      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;
      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 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;
      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 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;
      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 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;
      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 requiresallPorts 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 requiresallPorts 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. [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. [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. [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. [Output Only] Creation timestamp inRFC3339
       text format.
       
      optional string creation_timestamp = 30525366;
      Returns:
      Whether the creationTimestamp field is set.
    • getCreationTimestamp

      String getCreationTimestamp()
       Output only. [Output Only] Creation timestamp inRFC3339
       text format.
       
      optional string creation_timestamp = 30525366;
      Returns:
      The creationTimestamp.
    • getCreationTimestampBytes

      com.google.protobuf.ByteString getCreationTimestampBytes()
       Output only. [Output Only] Creation timestamp inRFC3339
       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 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;
      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 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;
      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 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;
      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 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;
      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 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;
      Returns:
      The isMirroringCollector.
    • hasKind

      boolean hasKind()
       Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
       
      optional string kind = 3292052;
      Returns:
      Whether the kind field is set.
    • getKind

      String getKind()
       Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
       
      optional string kind = 3292052;
      Returns:
      The kind.
    • getKindBytes

      com.google.protobuf.ByteString getKindBytes()
       Output only. [Output Only] Type of the resource. Alwayscompute#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 error412 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 error412 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 error412 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 thesetLabels method. Each label key/value pair must comply withRFC1035.
       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 thesetLabels method. Each label key/value pair must comply withRFC1035.
       Label values may be empty.
       
      map<string, string> labels = 500195327;
    • getLabels

      Deprecated.
      Use getLabelsMap() instead.
    • getLabelsMap

      Map<String,String> 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;
    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       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;
    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       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;
    • 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.
    • getMetadataFiltersList

      List<MetadataFilter> getMetadataFiltersList()
       Opaque filter criteria used by load balancer to restrict routing
       configuration to a limited set of xDS
       compliant clients. In their xDS requests to load balancer, xDS clients
       present node
       metadata. When there is a match, the relevant configuration
       is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
       referenced by the ForwardingRule are not visible to
       those proxies.
      
       For each metadataFilter in this list, if 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;
    • getMetadataFilters

      MetadataFilter getMetadataFilters(int index)
       Opaque filter criteria used by load balancer to restrict routing
       configuration to a limited set of xDS
       compliant clients. In their xDS requests to load balancer, xDS clients
       present node
       metadata. When there is a match, the relevant configuration
       is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
       referenced by the ForwardingRule are not visible to
       those proxies.
      
       For each metadataFilter in this list, if 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;
    • getMetadataFiltersCount

      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;
    • getMetadataFiltersOrBuilderList

      List<? extends MetadataFilterOrBuilder> getMetadataFiltersOrBuilderList()
       Opaque filter criteria used by load balancer to restrict routing
       configuration to a limited set of xDS
       compliant clients. In their xDS requests to load balancer, xDS clients
       present node
       metadata. When there is a match, the relevant configuration
       is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
       referenced by the ForwardingRule are not visible to
       those proxies.
      
       For each metadataFilter in this list, if 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;
    • getMetadataFiltersOrBuilder

      MetadataFilterOrBuilder getMetadataFiltersOrBuilder(int index)
       Opaque filter criteria used by load balancer to restrict routing
       configuration to a limited set of xDS
       compliant clients. In their xDS requests to load balancer, xDS clients
       present node
       metadata. When there is a match, the relevant configuration
       is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
       referenced by the ForwardingRule are not visible to
       those proxies.
      
       For each metadataFilter in this list, if 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;
    • hasName

      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;
      Returns:
      Whether the name field is set.
    • getName

      String getName()
       Name of the resource; provided by the client when the resource is created.
       The name must be 1-63 characters long, and comply 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;
      Returns:
      The name.
    • getNameBytes

      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;
      Returns:
      The bytes for name.
    • hasNetwork

      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;
      Returns:
      Whether the network field is set.
    • getNetwork

      String getNetwork()
       This field is not used for global external load balancing.
      
       For internal passthrough Network Load Balancers, this field identifies the
       network that the load balanced IP should belong to for this forwarding
       rule.
       If the subnetwork is specified, the network of the subnetwork will be used.
       If neither subnetwork nor this field is specified, the default network will
       be used.
      
       For Private Service Connect forwarding rules that forward traffic to Google
       APIs, a network must be provided.
       
      optional string network = 232872494;
      Returns:
      The network.
    • getNetworkBytes

      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;
      Returns:
      The bytes for network.
    • hasNetworkTier

      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;
      Returns:
      Whether the networkTier field is set.
    • getNetworkTier

      String getNetworkTier()
       This signifies the networking tier used for configuring
       this load balancer and can only take the following values:PREMIUM, STANDARD.
      
       For regional ForwardingRule, the valid values are PREMIUM 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;
      Returns:
      The networkTier.
    • getNetworkTierBytes

      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;
      Returns:
      The bytes for networkTier.
    • hasNoAutomateDnsZone

      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;
      Returns:
      Whether the noAutomateDnsZone field is set.
    • getNoAutomateDnsZone

      boolean getNoAutomateDnsZone()
       This is used in PSC consumer ForwardingRule to control whether it should
       try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
       this field. Once set, this field is not mutable.
       
      optional bool no_automate_dns_zone = 64546991;
      Returns:
      The noAutomateDnsZone.
    • hasPortRange

      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;
      Returns:
      Whether the portRange field is set.
    • getPortRange

      String getPortRange()
       The ports, portRange, and allPorts
       fields are mutually exclusive. Only packets addressed to ports in the
       specified range will be forwarded to the backends configured with this
       forwarding rule.
      
       The portRange field has the following limitations:
      
       - It requires that the forwarding rule IPProtocol be TCP,
       UDP, or SCTP, and
       - It's applicable only to the following products: external passthrough
       Network Load Balancers, internal and external proxy Network Load Balancers,
       internal and external Application Load Balancers, external protocol
       forwarding, and Classic VPN.
       - Some products have restrictions on what ports can be used. See
       port specifications for details.
      
      
      
       For external forwarding rules, two or more forwarding rules cannot use the
       same [IPAddress, IPProtocol] pair, and cannot have 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;
      Returns:
      The portRange.
    • getPortRangeBytes

      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;
      Returns:
      The bytes for portRange.
    • getPortsList

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

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

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

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ports at the given index.
    • hasPscConnectionId

      boolean hasPscConnectionId()
       [Output Only] The PSC connection id of the PSC forwarding rule.
       
      optional uint64 psc_connection_id = 292082397;
      Returns:
      Whether the pscConnectionId field is set.
    • getPscConnectionId

      long getPscConnectionId()
       [Output Only] The PSC connection id of the PSC forwarding rule.
       
      optional uint64 psc_connection_id = 292082397;
      Returns:
      The pscConnectionId.
    • hasPscConnectionStatus

      boolean hasPscConnectionStatus()
      
       Check the PscConnectionStatus enum for the list of possible values.
       
      optional string psc_connection_status = 184149172;
      Returns:
      Whether the pscConnectionStatus field is set.
    • getPscConnectionStatus

      String getPscConnectionStatus()
      
       Check the PscConnectionStatus enum for the list of possible values.
       
      optional string psc_connection_status = 184149172;
      Returns:
      The pscConnectionStatus.
    • getPscConnectionStatusBytes

      com.google.protobuf.ByteString getPscConnectionStatusBytes()
      
       Check the PscConnectionStatus enum for the list of possible values.
       
      optional string psc_connection_status = 184149172;
      Returns:
      The bytes for pscConnectionStatus.
    • hasRegion

      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;
      Returns:
      Whether the region field is set.
    • getRegion

      String 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;
      Returns:
      The region.
    • getRegionBytes

      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;
      Returns:
      The bytes for region.
    • hasSelfLink

      boolean hasSelfLink()
       [Output Only] Server-defined URL for the resource.
       
      optional string self_link = 456214797;
      Returns:
      Whether the selfLink field is set.
    • getSelfLink

      String getSelfLink()
       [Output Only] Server-defined URL for the resource.
       
      optional string self_link = 456214797;
      Returns:
      The selfLink.
    • getSelfLinkBytes

      com.google.protobuf.ByteString getSelfLinkBytes()
       [Output Only] Server-defined URL for the resource.
       
      optional string self_link = 456214797;
      Returns:
      The bytes for selfLink.
    • hasSelfLinkWithId

      boolean hasSelfLinkWithId()
       Output only. [Output Only] Server-defined URL for this resource with the resource id.
       
      optional string self_link_with_id = 44520962;
      Returns:
      Whether the selfLinkWithId field is set.
    • getSelfLinkWithId

      String getSelfLinkWithId()
       Output only. [Output Only] Server-defined URL for this resource with the resource id.
       
      optional string self_link_with_id = 44520962;
      Returns:
      The selfLinkWithId.
    • getSelfLinkWithIdBytes

      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;
      Returns:
      The bytes for selfLinkWithId.
    • getServiceDirectoryRegistrationsList

      List<ForwardingRuleServiceDirectoryRegistration> getServiceDirectoryRegistrationsList()
       Service Directory resources to register this forwarding rule with.
       Currently, only supports a single Service Directory resource.
       
      repeated .google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistration service_directory_registrations = 223549694;
    • getServiceDirectoryRegistrations

      ForwardingRuleServiceDirectoryRegistration getServiceDirectoryRegistrations(int index)
       Service Directory resources to register this forwarding rule with.
       Currently, only supports a single Service Directory resource.
       
      repeated .google.cloud.compute.v1.ForwardingRuleServiceDirectoryRegistration service_directory_registrations = 223549694;
    • getServiceDirectoryRegistrationsCount

      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;
    • getServiceDirectoryRegistrationsOrBuilderList

      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;
    • getServiceDirectoryRegistrationsOrBuilder

      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;
    • hasServiceLabel

      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;
      Returns:
      Whether the serviceLabel field is set.
    • getServiceLabel

      String getServiceLabel()
       An optional prefix to the service name for this forwarding rule.
       If specified, the prefix is the first label of the fully qualified service
       name.
      
       The label must be 1-63 characters long, and comply 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;
      Returns:
      The serviceLabel.
    • getServiceLabelBytes

      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;
      Returns:
      The bytes for serviceLabel.
    • hasServiceName

      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;
      Returns:
      Whether the serviceName field is set.
    • getServiceName

      String getServiceName()
       [Output Only]
       The internal fully qualified service name for this forwarding rule.
      
       This field is only used for internal load balancing.
       
      optional string service_name = 359880149;
      Returns:
      The serviceName.
    • getServiceNameBytes

      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;
      Returns:
      The bytes for serviceName.
    • getSourceIpRangesList

      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.
       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;
      Returns:
      A list containing the sourceIpRanges.
    • getSourceIpRangesCount

      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;
      Returns:
      The count of sourceIpRanges.
    • getSourceIpRanges

      String getSourceIpRanges(int index)
       If not empty, this forwarding rule will only forward the traffic when the
       source IP address matches one of the IP addresses or CIDR ranges set here.
       Note that a forwarding rule can only have up to 64 source IP ranges, and
       this field can only be used with a regional forwarding rule whose scheme 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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The sourceIpRanges at the given index.
    • getSourceIpRangesBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the sourceIpRanges at the given index.
    • hasSubnetwork

      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;
      Returns:
      Whether the subnetwork field is set.
    • getSubnetwork

      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.
      
       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;
      Returns:
      The subnetwork.
    • getSubnetworkBytes

      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;
      Returns:
      The bytes for subnetwork.
    • hasTarget

      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;
      Returns:
      Whether the target field is set.
    • getTarget

      String getTarget()
       The URL of the target resource to receive the matched traffic.  For
       regional forwarding rules, this target must be in the same region as the
       forwarding rule. For global forwarding rules, this target must be a global
       load balancing resource.
      
       The forwarded traffic must be of a type appropriate to the target object.
      
      
       -  For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
       -  For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
      
      
       -  vpc-sc -  APIs that support VPC Service Controls.
       -  all-apis - All supported Google APIs.
      
      
       -  For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
       
      optional string target = 192835985;
      Returns:
      The target.
    • getTargetBytes

      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;
      Returns:
      The bytes for target.