Class protos.google.container.v1.UpgradeDetails (6.7.0)

Represents an UpgradeDetails.

Package

@google-cloud/container

Constructors

(constructor)(properties)

constructor(properties?: google.container.v1.IUpgradeDetails);

Constructs a new UpgradeDetails.

Parameter
Name Description
properties IUpgradeDetails

Properties to set

Properties

endTime

public endTime?: (google.protobuf.ITimestamp|null);

UpgradeDetails endTime.

initialVersion

public initialVersion: string;

UpgradeDetails initialVersion.

startTime

public startTime?: (google.protobuf.ITimestamp|null);

UpgradeDetails startTime.

startType

public startType: (google.container.v1.UpgradeDetails.StartType|keyof typeof google.container.v1.UpgradeDetails.StartType);

UpgradeDetails startType.

state

public state: (google.container.v1.UpgradeDetails.State|keyof typeof google.container.v1.UpgradeDetails.State);

UpgradeDetails state.

targetVersion

public targetVersion: string;

UpgradeDetails targetVersion.

Methods

create(properties)

public static create(properties?: google.container.v1.IUpgradeDetails): google.container.v1.UpgradeDetails;

Creates a new UpgradeDetails instance using the specified properties.

Parameter
Name Description
properties IUpgradeDetails

Properties to set

Returns
Type Description
UpgradeDetails

UpgradeDetails instance

decode(reader, length)

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

Decodes an UpgradeDetails 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
UpgradeDetails

UpgradeDetails

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1.UpgradeDetails;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
UpgradeDetails

UpgradeDetails

encode(message, writer)

public static encode(message: google.container.v1.IUpgradeDetails, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UpgradeDetails message. Does not implicitly messages.

Parameters
Name Description
message IUpgradeDetails

UpgradeDetails 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.v1.IUpgradeDetails, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IUpgradeDetails

UpgradeDetails 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.v1.UpgradeDetails;

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

UpgradeDetails

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for UpgradeDetails

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message UpgradeDetails

UpgradeDetails

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 UpgradeDetails 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