Class: Google::Cloud::Compute::V1::ForwardingRule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/compute/v1/compute.rb

Overview

Represents a Forwarding Rule resource.

Forwarding rule resources in Google Cloud can be either regional or global in scope:

A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway).

For more information, read Forwarding rule concepts and Using protocol forwarding.

Defined Under Namespace

Modules: ExternalManagedBackendBucketMigrationState, IPProtocolEnum, IpVersion, LoadBalancingScheme, NetworkTier, PscConnectionStatus Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#all_ports::Boolean

Returns 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.

Returns:

  • (::Boolean)

    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.


20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#allow_global_access::Boolean

Returns 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.

Returns:

  • (::Boolean)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#allow_psc_global_access::Boolean

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

Returns:

  • (::Boolean)

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



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#backend_service::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#base_forwarding_rule::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#creation_timestamp::String

Returns Output only. [Output Only] Creation timestamp inRFC3339 text format.

Returns:

  • (::String)

    Output only. [Output Only] Creation timestamp inRFC3339 text format.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#description::String

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

Returns:

  • (::String)

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



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#external_managed_backend_bucket_migration_state::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#external_managed_backend_bucket_migration_testing_percentage::Float

Returns 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.

Returns:

  • (::Float)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#fingerprint::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#I_p_address::String

Returns 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:

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.

When reading an IPAddress, the API always returns the IP address number.

Returns:

  • (::String)

    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:

    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.

    When reading an IPAddress, the API always returns the IP address number.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#I_p_protocol::String

Returns 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. Check the IPProtocolEnum enum for the list of possible values.

Returns:

  • (::String)

    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. Check the IPProtocolEnum enum for the list of possible values.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#id::Integer

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

Returns:

  • (::Integer)

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



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#ip_collection::String

Returns 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.

Returns:

  • (::String)

    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


20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#ip_version::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#is_mirroring_collector::Boolean

Returns 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.

Returns:

  • (::Boolean)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#kind::String

Returns Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.

Returns:

  • (::String)

    Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#label_fingerprint::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#labels::Google::Protobuf::Map{::String => ::String}

Returns 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.

Returns:

  • (::Google::Protobuf::Map{::String => ::String})

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#load_balancing_scheme::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#metadata_filters::Array<::Google::Cloud::Compute::V1::MetadataFilter>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Compute::V1::MetadataFilter>)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#name::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#network::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#network_tier::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#no_automate_dns_zone::Boolean

Returns 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.

Returns:

  • (::Boolean)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#port_range::String

Returns 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+)?.

Returns:

  • (::String)

    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+)?



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#ports::Array<::String>

Returns 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+)?.

Returns:

  • (::Array<::String>)

    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+)?



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#psc_connection_id::Integer

Returns [Output Only] The PSC connection id of the PSC forwarding rule.

Returns:

  • (::Integer)

    [Output Only] The PSC connection id of the PSC forwarding rule.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#psc_connection_status::String

Returns Check the PscConnectionStatus enum for the list of possible values.

Returns:

  • (::String)

    Check the PscConnectionStatus enum for the list of possible values.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#region::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

Returns [Output Only] Server-defined URL for the resource.

Returns:

  • (::String)

    [Output Only] Server-defined URL for the resource.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

Returns Output only. [Output Only] Server-defined URL for this resource with the resource id.

Returns:

  • (::String)

    Output only. [Output Only] Server-defined URL for this resource with the resource id.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#service_directory_registrations::Array<::Google::Cloud::Compute::V1::ForwardingRuleServiceDirectoryRegistration>

Returns Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

Returns:



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#service_label::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#service_name::String

Returns [Output Only] The internal fully qualified service name for this forwarding rule.

This field is only used for internal load balancing.

Returns:

  • (::String)

    [Output Only] The internal fully qualified service name for this forwarding rule.

    This field is only used for internal load balancing.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#source_ip_ranges::Array<::String>

Returns 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).

Returns:

  • (::Array<::String>)

    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).



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#subnetwork::String

Returns 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.

Returns:

  • (::String)

    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.



20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end

#target::String

Returns 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.

Returns:

  • (::String)

    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.
    


20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 20924

class ForwardingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  module ExternalManagedBackendBucketMigrationState
    # A value indicating that the enum field is not set.
    UNDEFINED_EXTERNAL_MANAGED_BACKEND_BUCKET_MIGRATION_STATE = 0

    PREPARE = 399_612_135

    TEST_ALL_TRAFFIC = 79_728_882

    TEST_BY_PERCENTAGE = 513_738_389
  end

  # 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).
  module IPProtocolEnum
    # A value indicating that the enum field is not set.
    UNDEFINED_I_P_PROTOCOL_ENUM = 0

    AH = 2087

    ESP = 68_962

    ICMP = 2_241_597

    L3_DEFAULT = 48_151_369

    SCTP = 2_539_724

    TCP = 82_881

    UDP = 83_873
  end

  # The IP Version that will be used by this forwarding rule.  Valid options
  # are IPV4 or IPV6.
  module IpVersion
    # A value indicating that the enum field is not set.
    UNDEFINED_IP_VERSION = 0

    IPV4 = 2_254_341

    IPV6 = 2_254_343

    UNSPECIFIED_VERSION = 21_850_000
  end

  # Specifies the forwarding rule type.
  #
  # For more information about forwarding rules, refer to
  # Forwarding rule concepts.
  module LoadBalancingScheme
    # A value indicating that the enum field is not set.
    UNDEFINED_LOAD_BALANCING_SCHEME = 0

    EXTERNAL = 35_607_499

    EXTERNAL_MANAGED = 512_006_923

    INTERNAL = 279_295_677

    INTERNAL_MANAGED = 37_350_397

    INTERNAL_SELF_MANAGED = 236_211_150

    INVALID = 530_283_991
  end

  # 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.
  module NetworkTier
    # A value indicating that the enum field is not set.
    UNDEFINED_NETWORK_TIER = 0

    # Public internet quality with fixed bandwidth.
    FIXED_STANDARD = 310_464_328

    # High quality, Google-grade network tier, support for all networking
    # products.
    PREMIUM = 399_530_551

    # Public internet quality, only limited support for other networking
    # products.
    STANDARD = 484_642_493

    # (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier
    # is expired or not configured.
    STANDARD_OVERRIDES_FIXED_STANDARD = 465_847_234
  end

  module PscConnectionStatus
    # A value indicating that the enum field is not set.
    UNDEFINED_PSC_CONNECTION_STATUS = 0

    # The connection has been accepted by the producer.
    ACCEPTED = 246_714_279

    # The connection has been closed by the producer and will not serve traffic
    # going forward.
    CLOSED = 380_163_436

    # The connection has been accepted by the producer, but the producer needs
    # to take further action before the forwarding rule can serve traffic.
    NEEDS_ATTENTION = 344_491_452

    # The connection is pending acceptance by the producer.
    PENDING = 35_394_935

    # The connection has been rejected by the producer.
    REJECTED = 174_130_302

    STATUS_UNSPECIFIED = 42_133_066
  end
end