Class protos.google.cloud.compute.v1.Backend (3.9.1)

Represents a Backend.

Package

Constructors

(constructor)(properties)

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

Constructs a new Backend.

Parameter
Name	Description
`properties`	`IBackend` Properties to set

Properties

_balancingMode

public _balancingMode?: "balancingMode";

Backend _balancingMode.

_capacityScaler

public _capacityScaler?: "capacityScaler";

Backend _capacityScaler.

_description

public _description?: "description";

Backend _description.

_failover

public _failover?: "failover";

Backend _failover.

_group

public _group?: "group";

Backend _group.

_maxConnections

public _maxConnections?: "maxConnections";

Backend _maxConnections.

_maxConnectionsPerEndpoint

public _maxConnectionsPerEndpoint?: "maxConnectionsPerEndpoint";

Backend _maxConnectionsPerEndpoint.

_maxConnectionsPerInstance

public _maxConnectionsPerInstance?: "maxConnectionsPerInstance";

Backend _maxConnectionsPerInstance.

_maxRate

public _maxRate?: "maxRate";

Backend _maxRate.

_maxRatePerEndpoint

public _maxRatePerEndpoint?: "maxRatePerEndpoint";

Backend _maxRatePerEndpoint.

_maxRatePerInstance

public _maxRatePerInstance?: "maxRatePerInstance";

Backend _maxRatePerInstance.

_maxUtilization

public _maxUtilization?: "maxUtilization";

Backend _maxUtilization.

balancingMode

public balancingMode?: (string|null);

Backend balancingMode.

capacityScaler

public capacityScaler?: (number|null);

Backend capacityScaler.

description

public description?: (string|null);

Backend description.

failover

public failover?: (boolean|null);

Backend failover.

group

public group?: (string|null);

Backend group.

maxConnections

public maxConnections?: (number|null);

Backend maxConnections.

maxConnectionsPerEndpoint

public maxConnectionsPerEndpoint?: (number|null);

Backend maxConnectionsPerEndpoint.

maxConnectionsPerInstance

public maxConnectionsPerInstance?: (number|null);

Backend maxConnectionsPerInstance.

maxRate

public maxRate?: (number|null);

Backend maxRate.

maxRatePerEndpoint

public maxRatePerEndpoint?: (number|null);

Backend maxRatePerEndpoint.

maxRatePerInstance

public maxRatePerInstance?: (number|null);

Backend maxRatePerInstance.

maxUtilization

public maxUtilization?: (number|null);

Backend maxUtilization.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IBackend): google.cloud.compute.v1.Backend;

Creates a new Backend instance using the specified properties.

Parameter
Name	Description
`properties`	`IBackend` Properties to set

Returns
Type	Description
`google.cloud.compute.v1.Backend`	Backend instance

decode(reader, length)

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

Decodes a Backend 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.Backend`	Backend

decodeDelimited(reader)

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

Decodes a Backend 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.Backend`	Backend

encode(message, writer)

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

Encodes the specified Backend message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IBackend` Backend 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.IBackend, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IBackend` Backend 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.Backend;

Creates a Backend 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.Backend`	Backend

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Backend

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

toJSON()

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

Converts this Backend to JSON.

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`google.cloud.compute.v1.Backend` Backend
`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 Backend 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