com.pulumi.googlenative.compute.v1.kotlin.outputs.BackendResponse.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-google-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.googlenative.compute.v1.kotlin.outputs

import kotlin.Boolean
import kotlin.Double
import kotlin.Int
import kotlin.String
import kotlin.Suppress

/**
 * Message containing information of one individual backend.
 * @property balancingMode 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.
 * @property capacityScaler 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. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.
 * @property description An optional description of this resource. Provide this property when you create the resource.
 * @property failover This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.
 * @property group 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](https://cloud.google.com/load-balancing/docs/backend-service#backends). 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.
 * @property maxConnections 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.
 * @property maxConnectionsPerEndpoint 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.
 * @property maxConnectionsPerInstance 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.
 * @property maxRate 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.
 * @property maxRatePerEndpoint 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.
 * @property maxRatePerInstance 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.
 * @property maxUtilization 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.
 */
public data class BackendResponse(
    public val balancingMode: String,
    public val capacityScaler: Double,
    public val description: String,
    public val failover: Boolean,
    public val group: String,
    public val maxConnections: Int,
    public val maxConnectionsPerEndpoint: Int,
    public val maxConnectionsPerInstance: Int,
    public val maxRate: Int,
    public val maxRatePerEndpoint: Double,
    public val maxRatePerInstance: Double,
    public val maxUtilization: Double,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.googlenative.compute.v1.outputs.BackendResponse): BackendResponse = BackendResponse(
            balancingMode = javaType.balancingMode(),
            capacityScaler = javaType.capacityScaler(),
            description = javaType.description(),
            failover = javaType.failover(),
            group = javaType.group(),
            maxConnections = javaType.maxConnections(),
            maxConnectionsPerEndpoint = javaType.maxConnectionsPerEndpoint(),
            maxConnectionsPerInstance = javaType.maxConnectionsPerInstance(),
            maxRate = javaType.maxRate(),
            maxRatePerEndpoint = javaType.maxRatePerEndpoint(),
            maxRatePerInstance = javaType.maxRatePerInstance(),
            maxUtilization = javaType.maxUtilization(),
        )
    }
}