Package com.google.cloud.compute.v1

Interface BackendOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Backend, Backend.Builder
@Generated public interface BackendOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasBalancingMode

      boolean hasBalancingMode()
       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.
      optional string balancing_mode = 430286217;
      Returns:
      Whether the balancingMode field is set.

    • getBalancingMode

      String getBalancingMode()
       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.
      optional string balancing_mode = 430286217;
      Returns:
      The balancingMode.

    • getBalancingModeBytes

      com.google.protobuf.ByteString getBalancingModeBytes()
       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.
      optional string balancing_mode = 430286217;
      Returns:
      The bytes for balancingMode.

    • hasCapacityScaler

      boolean hasCapacityScaler()
       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 onbalancingMode). 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 than0.1.
 You cannot configure a setting of 0 when there is only one
 backend attached to the backend service.

 Not available with backends that don't support using abalancingMode. This includes backends such as global
 internet NEGs, regional serverless NEGs, and PSC NEGs.
      optional float capacity_scaler = 315958157;
      Returns:
      Whether the capacityScaler field is set.

    • getCapacityScaler

      float getCapacityScaler()
       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 onbalancingMode). 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 than0.1.
 You cannot configure a setting of 0 when there is only one
 backend attached to the backend service.

 Not available with backends that don't support using abalancingMode. This includes backends such as global
 internet NEGs, regional serverless NEGs, and PSC NEGs.
      optional float capacity_scaler = 315958157;
      Returns:
      The capacityScaler.

    • getCustomMetricsList

      List<BackendCustomMetric> getCustomMetricsList()
       List of custom metrics that are used for CUSTOM_METRICS
 BalancingMode.
      repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

    • getCustomMetrics

      BackendCustomMetric getCustomMetrics(int index)
       List of custom metrics that are used for CUSTOM_METRICS
 BalancingMode.
      repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

    • getCustomMetricsCount

      int getCustomMetricsCount()
       List of custom metrics that are used for CUSTOM_METRICS
 BalancingMode.
      repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

    • getCustomMetricsOrBuilderList

      List<? extends BackendCustomMetricOrBuilder> getCustomMetricsOrBuilderList()
       List of custom metrics that are used for CUSTOM_METRICS
 BalancingMode.
      repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

    • getCustomMetricsOrBuilder

      BackendCustomMetricOrBuilder getCustomMetricsOrBuilder(int index)
       List of custom metrics that are used for CUSTOM_METRICS
 BalancingMode.
      repeated .google.cloud.compute.v1.BackendCustomMetric custom_metrics = 429453813;

    • hasDescription

      boolean hasDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The bytes for description.

    • hasFailover

      boolean hasFailover()
       This field designates whether this is a failover backend. More than one
 failover backend can be configured for a given BackendService.
      optional bool failover = 138892530;
      Returns:
      Whether the failover field is set.

    • getFailover

      boolean getFailover()
       This field designates whether this is a failover backend. More than one
 failover backend can be configured for a given BackendService.
      optional bool failover = 138892530;
      Returns:
      The failover.

    • hasGroup

      boolean hasGroup()
       The fully-qualified URL of aninstance
 group or network endpoint
 group (NEG) resource. To determine what types of backends a load
 balancer supports, see the [Backend services
 overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).

 You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
 or NEG. Partial URLs are not supported.

 If haPolicy is specified, backends must refer to NEG resources of type
 GCE_VM_IP.
      optional string group = 98629247;
      Returns:
      Whether the group field is set.

    • getGroup

      String getGroup()
       The fully-qualified URL of aninstance
 group or network endpoint
 group (NEG) resource. To determine what types of backends a load
 balancer supports, see the [Backend services
 overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).

 You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
 or NEG. Partial URLs are not supported.

 If haPolicy is specified, backends must refer to NEG resources of type
 GCE_VM_IP.
      optional string group = 98629247;
      Returns:
      The group.

    • getGroupBytes

      com.google.protobuf.ByteString getGroupBytes()
       The fully-qualified URL of aninstance
 group or network endpoint
 group (NEG) resource. To determine what types of backends a load
 balancer supports, see the [Backend services
 overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).

 You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
 or NEG. Partial URLs are not supported.

 If haPolicy is specified, backends must refer to NEG resources of type
 GCE_VM_IP.
      optional string group = 98629247;
      Returns:
      The bytes for group.

    • hasMaxConnections

      boolean hasMaxConnections()
       Defines a target maximum number of simultaneous connections. For usage
 guidelines, seeConnection
 balancing mode and Utilization
 balancing mode. Not available if the backend'sbalancingMode is RATE.
      optional int32 max_connections = 110652154;
      Returns:
      Whether the maxConnections field is set.

    • getMaxConnections

      int getMaxConnections()
       Defines a target maximum number of simultaneous connections. For usage
 guidelines, seeConnection
 balancing mode and Utilization
 balancing mode. Not available if the backend'sbalancingMode is RATE.
      optional int32 max_connections = 110652154;
      Returns:
      The maxConnections.

    • hasMaxConnectionsPerEndpoint

      boolean hasMaxConnectionsPerEndpoint()
       Defines a target maximum number of simultaneous connections.  For usage
 guidelines, seeConnection
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isRATE.
      optional int32 max_connections_per_endpoint = 216904604;
      Returns:
      Whether the maxConnectionsPerEndpoint field is set.

    • getMaxConnectionsPerEndpoint

      int getMaxConnectionsPerEndpoint()
       Defines a target maximum number of simultaneous connections.  For usage
 guidelines, seeConnection
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isRATE.
      optional int32 max_connections_per_endpoint = 216904604;
      Returns:
      The maxConnectionsPerEndpoint.

    • hasMaxConnectionsPerInstance

      boolean hasMaxConnectionsPerInstance()
       Defines a target maximum number of simultaneous connections.
 For usage guidelines, seeConnection
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isRATE.
      optional int32 max_connections_per_instance = 104671900;
      Returns:
      Whether the maxConnectionsPerInstance field is set.

    • getMaxConnectionsPerInstance

      int getMaxConnectionsPerInstance()
       Defines a target maximum number of simultaneous connections.
 For usage guidelines, seeConnection
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isRATE.
      optional int32 max_connections_per_instance = 104671900;
      Returns:
      The maxConnectionsPerInstance.

    • hasMaxInFlightRequests

      boolean hasMaxInFlightRequests()
       Defines a maximum number of in-flight requests for the whole NEG or
 instance group. Not available if backend's balancingMode isRATE or CONNECTION.
      optional int32 max_in_flight_requests = 273269332;
      Returns:
      Whether the maxInFlightRequests field is set.

    • getMaxInFlightRequests

      int getMaxInFlightRequests()
       Defines a maximum number of in-flight requests for the whole NEG or
 instance group. Not available if backend's balancingMode isRATE or CONNECTION.
      optional int32 max_in_flight_requests = 273269332;
      Returns:
      The maxInFlightRequests.

    • hasMaxInFlightRequestsPerEndpoint

      boolean hasMaxInFlightRequestsPerEndpoint()
       Defines a maximum number of in-flight requests for a single endpoint.
 Not available if backend's balancingMode is RATE
 or CONNECTION.
      optional int32 max_in_flight_requests_per_endpoint = 307928706;
      Returns:
      Whether the maxInFlightRequestsPerEndpoint field is set.

    • getMaxInFlightRequestsPerEndpoint

      int getMaxInFlightRequestsPerEndpoint()
       Defines a maximum number of in-flight requests for a single endpoint.
 Not available if backend's balancingMode is RATE
 or CONNECTION.
      optional int32 max_in_flight_requests_per_endpoint = 307928706;
      Returns:
      The maxInFlightRequestsPerEndpoint.

    • hasMaxInFlightRequestsPerInstance

      boolean hasMaxInFlightRequestsPerInstance()
       Defines a maximum number of in-flight requests for a single VM.
 Not available if backend's balancingMode is RATE
 or CONNECTION.
      optional int32 max_in_flight_requests_per_instance = 195696002;
      Returns:
      Whether the maxInFlightRequestsPerInstance field is set.

    • getMaxInFlightRequestsPerInstance

      int getMaxInFlightRequestsPerInstance()
       Defines a maximum number of in-flight requests for a single VM.
 Not available if backend's balancingMode is RATE
 or CONNECTION.
      optional int32 max_in_flight_requests_per_instance = 195696002;
      Returns:
      The maxInFlightRequestsPerInstance.

    • hasMaxRate

      boolean hasMaxRate()
       Defines a maximum number of HTTP requests per second (RPS). For
 usage guidelines, seeRate
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isCONNECTION.
      optional int32 max_rate = 408035035;
      Returns:
      Whether the maxRate field is set.

    • getMaxRate

      int getMaxRate()
       Defines a maximum number of HTTP requests per second (RPS). For
 usage guidelines, seeRate
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isCONNECTION.
      optional int32 max_rate = 408035035;
      Returns:
      The maxRate.

    • hasMaxRatePerEndpoint

      boolean hasMaxRatePerEndpoint()
       Defines a maximum target for requests per second (RPS). For usage
 guidelines, seeRate
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isCONNECTION.
      optional float max_rate_per_endpoint = 129832283;
      Returns:
      Whether the maxRatePerEndpoint field is set.

    • getMaxRatePerEndpoint

      float getMaxRatePerEndpoint()
       Defines a maximum target for requests per second (RPS). For usage
 guidelines, seeRate
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isCONNECTION.
      optional float max_rate_per_endpoint = 129832283;
      Returns:
      The maxRatePerEndpoint.

    • hasMaxRatePerInstance

      boolean hasMaxRatePerInstance()
       Defines a maximum target for requests per second (RPS). For usage
 guidelines, seeRate
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isCONNECTION.
      optional float max_rate_per_instance = 17599579;
      Returns:
      Whether the maxRatePerInstance field is set.

    • getMaxRatePerInstance

      float getMaxRatePerInstance()
       Defines a maximum target for requests per second (RPS). For usage
 guidelines, seeRate
 balancing mode and Utilization
 balancing mode.

 Not available if the backend's balancingMode isCONNECTION.
      optional float max_rate_per_instance = 17599579;
      Returns:
      The maxRatePerInstance.

    • hasMaxUtilization

      boolean hasMaxUtilization()
       Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].

 For usage guidelines, seeUtilization
 balancing mode.
      optional float max_utilization = 148192199;
      Returns:
      Whether the maxUtilization field is set.

    • getMaxUtilization

      float getMaxUtilization()
       Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].

 For usage guidelines, seeUtilization
 balancing mode.
      optional float max_utilization = 148192199;
      Returns:
      The maxUtilization.

    • hasOrchestrationInfo

      boolean hasOrchestrationInfo()
       Information about the resource or system that manages the backend.
      optional .google.cloud.compute.v1.BackendBackendOrchestrationInfo orchestration_info = 441144300;
      Returns:
      Whether the orchestrationInfo field is set.

    • getOrchestrationInfo

      BackendBackendOrchestrationInfo getOrchestrationInfo()
       Information about the resource or system that manages the backend.
      optional .google.cloud.compute.v1.BackendBackendOrchestrationInfo orchestration_info = 441144300;
      Returns:
      The orchestrationInfo.

    • getOrchestrationInfoOrBuilder

      BackendBackendOrchestrationInfoOrBuilder getOrchestrationInfoOrBuilder()
       Information about the resource or system that manages the backend.
      optional .google.cloud.compute.v1.BackendBackendOrchestrationInfo orchestration_info = 441144300;

    • hasPreference

      boolean hasPreference()
       This field indicates whether this backend should be fully utilized before
 sending traffic to backends with default preference. The possible values
 are:

 - PREFERRED: Backends with this preference level will be
 filled up to their capacity limits first, based on RTT.
 - DEFAULT:  If preferred backends don't have enough
 capacity, backends in this layer would be used and traffic would be
 assigned based on the load balancing algorithm you use. This is the
 default
 Check the Preference enum for the list of possible values.
      optional string preference = 150781147;
      Returns:
      Whether the preference field is set.

    • getPreference

      String getPreference()
       This field indicates whether this backend should be fully utilized before
 sending traffic to backends with default preference. The possible values
 are:

 - PREFERRED: Backends with this preference level will be
 filled up to their capacity limits first, based on RTT.
 - DEFAULT:  If preferred backends don't have enough
 capacity, backends in this layer would be used and traffic would be
 assigned based on the load balancing algorithm you use. This is the
 default
 Check the Preference enum for the list of possible values.
      optional string preference = 150781147;
      Returns:
      The preference.

    • getPreferenceBytes

      com.google.protobuf.ByteString getPreferenceBytes()
       This field indicates whether this backend should be fully utilized before
 sending traffic to backends with default preference. The possible values
 are:

 - PREFERRED: Backends with this preference level will be
 filled up to their capacity limits first, based on RTT.
 - DEFAULT:  If preferred backends don't have enough
 capacity, backends in this layer would be used and traffic would be
 assigned based on the load balancing algorithm you use. This is the
 default
 Check the Preference enum for the list of possible values.
      optional string preference = 150781147;
      Returns:
      The bytes for preference.

    • hasTrafficDuration

      boolean hasTrafficDuration()
      
 Check the TrafficDuration enum for the list of possible values.
      optional string traffic_duration = 11618710;
      Returns:
      Whether the trafficDuration field is set.

    • getTrafficDuration

      String getTrafficDuration()
      
 Check the TrafficDuration enum for the list of possible values.
      optional string traffic_duration = 11618710;
      Returns:
      The trafficDuration.

    • getTrafficDurationBytes

      com.google.protobuf.ByteString getTrafficDurationBytes()
      
 Check the TrafficDuration enum for the list of possible values.
      optional string traffic_duration = 11618710;
      Returns:
      The bytes for trafficDuration.