Class CircuitBreakers (1.18.0)

public final class CircuitBreakers extends GeneratedMessageV3 implements CircuitBreakersOrBuilder

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

Protobuf type google.cloud.compute.v1.CircuitBreakers

Static Fields

MAX_CONNECTIONS_FIELD_NUMBER

public static final int MAX_CONNECTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_PENDING_REQUESTS_FIELD_NUMBER

public static final int MAX_PENDING_REQUESTS_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_REQUESTS_FIELD_NUMBER

public static final int MAX_REQUESTS_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_REQUESTS_PER_CONNECTION_FIELD_NUMBER

public static final int MAX_REQUESTS_PER_CONNECTION_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_RETRIES_FIELD_NUMBER

public static final int MAX_RETRIES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CircuitBreakers getDefaultInstance()
Returns
TypeDescription
CircuitBreakers

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CircuitBreakers.Builder newBuilder()
Returns
TypeDescription
CircuitBreakers.Builder

newBuilder(CircuitBreakers prototype)

public static CircuitBreakers.Builder newBuilder(CircuitBreakers prototype)
Parameter
NameDescription
prototypeCircuitBreakers
Returns
TypeDescription
CircuitBreakers.Builder

parseDelimitedFrom(InputStream input)

public static CircuitBreakers parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CircuitBreakers parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CircuitBreakers parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CircuitBreakers parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CircuitBreakers parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CircuitBreakers parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CircuitBreakers parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CircuitBreakers parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CircuitBreakers parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CircuitBreakers parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CircuitBreakers parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CircuitBreakers parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CircuitBreakers
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CircuitBreakers> parser()
Returns
TypeDescription
Parser<CircuitBreakers>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CircuitBreakers getDefaultInstanceForType()
Returns
TypeDescription
CircuitBreakers

getMaxConnections()

public int 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.

optional int32 max_connections = 110652154;

Returns
TypeDescription
int

The maxConnections.

getMaxPendingRequests()

public int 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.

optional int32 max_pending_requests = 375558887;

Returns
TypeDescription
int

The maxPendingRequests.

getMaxRequests()

public int getMaxRequests()

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

optional int32 max_requests = 28097599;

Returns
TypeDescription
int

The maxRequests.

getMaxRequestsPerConnection()

public int 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.

optional int32 max_requests_per_connection = 361630528;

Returns
TypeDescription
int

The maxRequestsPerConnection.

getMaxRetries()

public int 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.

optional int32 max_retries = 55546219;

Returns
TypeDescription
int

The maxRetries.

getParserForType()

public Parser<CircuitBreakers> getParserForType()
Returns
TypeDescription
Parser<CircuitBreakers>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasMaxConnections()

public boolean hasMaxConnections()

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.

optional int32 max_connections = 110652154;

Returns
TypeDescription
boolean

Whether the maxConnections field is set.

hasMaxPendingRequests()

public boolean hasMaxPendingRequests()

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.

optional int32 max_pending_requests = 375558887;

Returns
TypeDescription
boolean

Whether the maxPendingRequests field is set.

hasMaxRequests()

public boolean hasMaxRequests()

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

optional int32 max_requests = 28097599;

Returns
TypeDescription
boolean

Whether the maxRequests field is set.

hasMaxRequestsPerConnection()

public boolean hasMaxRequestsPerConnection()

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.

optional int32 max_requests_per_connection = 361630528;

Returns
TypeDescription
boolean

Whether the maxRequestsPerConnection field is set.

hasMaxRetries()

public boolean hasMaxRetries()

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.

optional int32 max_retries = 55546219;

Returns
TypeDescription
boolean

Whether the maxRetries field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CircuitBreakers.Builder newBuilderForType()
Returns
TypeDescription
CircuitBreakers.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CircuitBreakers.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CircuitBreakers.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CircuitBreakers.Builder toBuilder()
Returns
TypeDescription
CircuitBreakers.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException