Class: Google::Cloud::Compute::V1::Backend

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

Overview

Message containing information of one individual backend.

Defined Under Namespace

Modules: BalancingMode

Instance Attribute Summary collapse

Instance Attribute Details

#balancing_mode ⇒ ::String

Returns Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. Check the BalancingMode enum for the list of possible values.

Returns:

  • (::String) —

    Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. Check the BalancingMode enum for the list of possible values.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#capacity_scaler ⇒ ::Float

Returns A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.

Returns:

  • (::Float) —

    A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  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.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#failover ⇒ ::Boolean

Returns This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

Returns:

  • (::Boolean) —

    This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#group ⇒ ::String

Returns The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

Returns:

  • (::String) —

    The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the Backend services overview. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#max_connections ⇒ ::Integer

Returns Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.

Returns:

  • (::Integer) —

    Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#max_connections_per_endpoint ⇒ ::Integer

Returns Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.

Returns:

  • (::Integer) —

    Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#max_connections_per_instance ⇒ ::Integer

Returns Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.

Returns:

  • (::Integer) —

    Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#max_rate ⇒ ::Integer

Returns Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.

Returns:

  • (::Integer) —

    Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#max_rate_per_endpoint ⇒ ::Float

Returns Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.

Returns:

  • (::Float) —

    Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#max_rate_per_instance ⇒ ::Float

Returns Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.

Returns:

  • (::Float) —

    Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end

#max_utilization ⇒ ::Float

Returns Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.

Returns:

  • (::Float) —

    Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.



2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 2749

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

  # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.
  module BalancingMode
    # A value indicating that the enum field is not set.
    UNDEFINED_BALANCING_MODE = 0

    # Balance based on the number of simultaneous connections.
    CONNECTION = 246311646

    # Balance based on requests per second (RPS).
    RATE = 2508000

    # Balance based on the backend utilization.
    UTILIZATION = 157008386
  end
end