Class protos.google.container.v1beta1.NodePool.UpgradeSettings (5.19.0)

Represents an UpgradeSettings.

Package

@google-cloud/container

Constructors

(constructor)(properties)

constructor(properties?: google.container.v1beta1.NodePool.IUpgradeSettings);

Constructs a new UpgradeSettings.

Parameter
Name Description
properties IUpgradeSettings

Properties to set

Properties

_blueGreenSettings

public _blueGreenSettings?: "blueGreenSettings";

UpgradeSettings _blueGreenSettings.

_strategy

public _strategy?: "strategy";

UpgradeSettings _strategy.

blueGreenSettings

public blueGreenSettings?: (google.container.v1beta1.IBlueGreenSettings|null);

UpgradeSettings blueGreenSettings.

maxSurge

public maxSurge: number;

UpgradeSettings maxSurge.

maxUnavailable

public maxUnavailable: number;

UpgradeSettings maxUnavailable.

strategy

public strategy?: (google.container.v1beta1.NodePoolUpdateStrategy|keyof typeof google.container.v1beta1.NodePoolUpdateStrategy|null);

UpgradeSettings strategy.

Methods

create(properties)

public static create(properties?: google.container.v1beta1.NodePool.IUpgradeSettings): google.container.v1beta1.NodePool.UpgradeSettings;

Creates a new UpgradeSettings instance using the specified properties.

Parameter
Name Description
properties IUpgradeSettings

Properties to set

Returns
Type Description
UpgradeSettings

UpgradeSettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.container.v1beta1.NodePool.UpgradeSettings;

Decodes an UpgradeSettings message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
UpgradeSettings

UpgradeSettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1beta1.NodePool.UpgradeSettings;

Decodes an UpgradeSettings message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
UpgradeSettings

UpgradeSettings

encode(message, writer)

public static encode(message: google.container.v1beta1.NodePool.IUpgradeSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UpgradeSettings message. Does not implicitly messages.

Parameters
Name Description
message IUpgradeSettings

UpgradeSettings 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.container.v1beta1.NodePool.IUpgradeSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IUpgradeSettings

UpgradeSettings 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.container.v1beta1.NodePool.UpgradeSettings;

Creates an UpgradeSettings 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
UpgradeSettings

UpgradeSettings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for UpgradeSettings

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 UpgradeSettings to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.container.v1beta1.NodePool.UpgradeSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message UpgradeSettings

UpgradeSettings

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 an UpgradeSettings 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