Compute V1 Client - Class CircuitBreakers (1.20.0)

Reference documentation and code samples for the Compute V1 Client class CircuitBreakers.

Settings controlling the volume of requests, connections and retries to this backend service.

Generated from protobuf message google.cloud.compute.v1.CircuitBreakers

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ max_connections int

The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

↳ max_pending_requests int

The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

↳ max_requests int

The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

↳ max_requests_per_connection int

Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

↳ max_retries int

The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

getMaxConnections

The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns
Type Description
int

hasMaxConnections

clearMaxConnections

setMaxConnections

The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxPendingRequests

The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns
Type Description
int

hasMaxPendingRequests

clearMaxPendingRequests

setMaxPendingRequests

The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxRequests

The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

Returns
Type Description
int

hasMaxRequests

clearMaxRequests

setMaxRequests

The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxRequestsPerConnection

Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns
Type Description
int

hasMaxRequestsPerConnection

clearMaxRequestsPerConnection

setMaxRequestsPerConnection

Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxRetries

The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns
Type Description
int

hasMaxRetries

clearMaxRetries

setMaxRetries

The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Parameter
Name Description
var int
Returns
Type Description
$this