Class protos.google.cloud.gkebackup.v1.VolumeRestore (0.2.0)

Stay organized with collections Save and categorize content based on your preferences.

Represents a VolumeRestore.

Package

@google-cloud/gke-backup

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gkebackup.v1.IVolumeRestore);

Constructs a new VolumeRestore.

Parameter
NameDescription
properties IVolumeRestore

Properties to set

Properties

completeTime

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

VolumeRestore completeTime.

createTime

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

VolumeRestore createTime.

etag

public etag: string;

VolumeRestore etag.

name

public name: string;

VolumeRestore name.

state

public state: (google.cloud.gkebackup.v1.VolumeRestore.State|keyof typeof google.cloud.gkebackup.v1.VolumeRestore.State);

VolumeRestore state.

stateMessage

public stateMessage: string;

VolumeRestore stateMessage.

targetPvc

public targetPvc?: (google.cloud.gkebackup.v1.INamespacedName|null);

VolumeRestore targetPvc.

uid

public uid: string;

VolumeRestore uid.

updateTime

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

VolumeRestore updateTime.

volumeBackup

public volumeBackup: string;

VolumeRestore volumeBackup.

volumeHandle

public volumeHandle: string;

VolumeRestore volumeHandle.

volumeType

public volumeType: (google.cloud.gkebackup.v1.VolumeRestore.VolumeType|keyof typeof google.cloud.gkebackup.v1.VolumeRestore.VolumeType);

VolumeRestore volumeType.

Methods

create(properties)

public static create(properties?: google.cloud.gkebackup.v1.IVolumeRestore): google.cloud.gkebackup.v1.VolumeRestore;

Creates a new VolumeRestore instance using the specified properties.

Parameter
NameDescription
properties IVolumeRestore

Properties to set

Returns
TypeDescription
google.cloud.gkebackup.v1.VolumeRestore

VolumeRestore instance

decode(reader, length)

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

Decodes a VolumeRestore 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.gkebackup.v1.VolumeRestore

VolumeRestore

decodeDelimited(reader)

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

Decodes a VolumeRestore 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.gkebackup.v1.VolumeRestore

VolumeRestore

encode(message, writer)

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

Encodes the specified VolumeRestore message. Does not implicitly messages.

Parameters
NameDescription
message IVolumeRestore

VolumeRestore 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.gkebackup.v1.IVolumeRestore, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IVolumeRestore

VolumeRestore 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.gkebackup.v1.VolumeRestore;

Creates a VolumeRestore 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.gkebackup.v1.VolumeRestore

VolumeRestore

toJSON()

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

Converts this VolumeRestore to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.gkebackup.v1.VolumeRestore

VolumeRestore

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