Class protos.google.cloud.compute.v1.CircuitBreakers (3.1.2)

Represents a CircuitBreakers.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.ICircuitBreakers);

Constructs a new CircuitBreakers.

Parameter

Name	Description
properties	`ICircuitBreakers` Properties to set

Properties

_maxConnections

public _maxConnections?: "maxConnections";

CircuitBreakers _maxConnections.

_maxPendingRequests

public _maxPendingRequests?: "maxPendingRequests";

CircuitBreakers _maxPendingRequests.

_maxRequests

public _maxRequests?: "maxRequests";

CircuitBreakers _maxRequests.

_maxRequestsPerConnection

public _maxRequestsPerConnection?: "maxRequestsPerConnection";

CircuitBreakers _maxRequestsPerConnection.

_maxRetries

public _maxRetries?: "maxRetries";

CircuitBreakers _maxRetries.

maxConnections

public maxConnections?: (number|null);

CircuitBreakers maxConnections.

maxPendingRequests

public maxPendingRequests?: (number|null);

CircuitBreakers maxPendingRequests.

maxRequests

public maxRequests?: (number|null);

CircuitBreakers maxRequests.

maxRequestsPerConnection

public maxRequestsPerConnection?: (number|null);

CircuitBreakers maxRequestsPerConnection.

maxRetries

public maxRetries?: (number|null);

CircuitBreakers maxRetries.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ICircuitBreakers): google.cloud.compute.v1.CircuitBreakers;

Creates a new CircuitBreakers instance using the specified properties.

Parameter

Name	Description
properties	`ICircuitBreakers` Properties to set

Returns

Type	Description
google.cloud.compute.v1.CircuitBreakers	CircuitBreakers instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.CircuitBreakers;

Decodes a CircuitBreakers message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.compute.v1.CircuitBreakers	CircuitBreakers

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.CircuitBreakers;

Decodes a CircuitBreakers message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.compute.v1.CircuitBreakers	CircuitBreakers

encode(message, writer)

public static encode(message: google.cloud.compute.v1.ICircuitBreakers, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CircuitBreakers message. Does not implicitly messages.

Parameters

Name	Description
message	`ICircuitBreakers` CircuitBreakers message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.compute.v1.ICircuitBreakers, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CircuitBreakers message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`ICircuitBreakers` CircuitBreakers message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.CircuitBreakers;

Creates a CircuitBreakers message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.compute.v1.CircuitBreakers	CircuitBreakers

toJSON()

public toJSON(): { [k: string]: any };

Converts this CircuitBreakers to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.CircuitBreakers, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a CircuitBreakers message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.compute.v1.CircuitBreakers` CircuitBreakers
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a CircuitBreakers message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not