Class protos.google.cloud.compute.v1.BackendServiceFailoverPolicy

Represents a BackendServiceFailoverPolicy.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new BackendServiceFailoverPolicy.

Parameter
NameDescription
properties IBackendServiceFailoverPolicy

Properties to set

Properties

_disableConnectionDrainOnFailover

public _disableConnectionDrainOnFailover?: "disableConnectionDrainOnFailover";

BackendServiceFailoverPolicy _disableConnectionDrainOnFailover.

_dropTrafficIfUnhealthy

public _dropTrafficIfUnhealthy?: "dropTrafficIfUnhealthy";

BackendServiceFailoverPolicy _dropTrafficIfUnhealthy.

_failoverRatio

public _failoverRatio?: "failoverRatio";

BackendServiceFailoverPolicy _failoverRatio.

disableConnectionDrainOnFailover

public disableConnectionDrainOnFailover?: (boolean|null);

BackendServiceFailoverPolicy disableConnectionDrainOnFailover.

dropTrafficIfUnhealthy

public dropTrafficIfUnhealthy?: (boolean|null);

BackendServiceFailoverPolicy dropTrafficIfUnhealthy.

failoverRatio

public failoverRatio?: (number|null);

BackendServiceFailoverPolicy failoverRatio.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IBackendServiceFailoverPolicy): google.cloud.compute.v1.BackendServiceFailoverPolicy;

Creates a new BackendServiceFailoverPolicy instance using the specified properties.

Parameter
NameDescription
properties IBackendServiceFailoverPolicy

Properties to set

Returns
TypeDescription
google.cloud.compute.v1.BackendServiceFailoverPolicy

BackendServiceFailoverPolicy instance

decode(reader, length)

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

Decodes a BackendServiceFailoverPolicy message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.compute.v1.BackendServiceFailoverPolicy

BackendServiceFailoverPolicy

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.compute.v1.BackendServiceFailoverPolicy

BackendServiceFailoverPolicy

encode(message, writer)

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

Encodes the specified BackendServiceFailoverPolicy message. Does not implicitly messages.

Parameters
NameDescription
message IBackendServiceFailoverPolicy

BackendServiceFailoverPolicy message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IBackendServiceFailoverPolicy

BackendServiceFailoverPolicy message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.compute.v1.BackendServiceFailoverPolicy

BackendServiceFailoverPolicy

toJSON()

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

Converts this BackendServiceFailoverPolicy to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.compute.v1.BackendServiceFailoverPolicy

BackendServiceFailoverPolicy

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a BackendServiceFailoverPolicy message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not