Class protos.google.cloud.filestore.v1beta1.Backup

Represents a Backup.

Package

@google-cloud/filestore

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.filestore.v1beta1.IBackup);

Constructs a new Backup.

Parameter
NameDescription
properties IBackup

Properties to set

Properties

capacityGb

public capacityGb: (number|Long|string);

Backup capacityGb.

Property Value
TypeDescription
(number|Long|string)

createTime

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

Backup createTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

description

public description: string;

Backup description.

Property Value
TypeDescription
string

downloadBytes

public downloadBytes: (number|Long|string);

Backup downloadBytes.

Property Value
TypeDescription
(number|Long|string)

labels

public labels: { [k: string]: string };

Backup labels.

Property Value
TypeDescription
{ [k: string]: string }

name

public name: string;

Backup name.

Property Value
TypeDescription
string

satisfiesPzs

public satisfiesPzs?: (google.protobuf.IBoolValue|null);

Backup satisfiesPzs.

Property Value
TypeDescription
(google.protobuf.IBoolValue|null)

sourceFileShare

public sourceFileShare: string;

Backup sourceFileShare.

Property Value
TypeDescription
string

sourceInstance

public sourceInstance: string;

Backup sourceInstance.

Property Value
TypeDescription
string

sourceInstanceTier

public sourceInstanceTier: (google.cloud.filestore.v1beta1.Instance.Tier|keyof typeof google.cloud.filestore.v1beta1.Instance.Tier);

Backup sourceInstanceTier.

Property Value
TypeDescription
(google.cloud.filestore.v1beta1.Instance.Tier|keyof typeof google.cloud.filestore.v1beta1.Instance.Tier)

state

public state: (google.cloud.filestore.v1beta1.Backup.State|keyof typeof google.cloud.filestore.v1beta1.Backup.State);

Backup state.

Property Value
TypeDescription
(google.cloud.filestore.v1beta1.Backup.State|keyof typeof google.cloud.filestore.v1beta1.Backup.State)

storageBytes

public storageBytes: (number|Long|string);

Backup storageBytes.

Property Value
TypeDescription
(number|Long|string)

Methods

create(properties)

public static create(properties?: google.cloud.filestore.v1beta1.IBackup): google.cloud.filestore.v1beta1.Backup;

Creates a new Backup instance using the specified properties.

Parameter
NameDescription
properties IBackup

Properties to set

Returns
TypeDescription
google.cloud.filestore.v1beta1.Backup

Backup instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.filestore.v1beta1.Backup;

Decodes a Backup 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.filestore.v1beta1.Backup

Backup

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.filestore.v1beta1.Backup;

Decodes a Backup 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.filestore.v1beta1.Backup

Backup

encode(message, writer)

public static encode(message: google.cloud.filestore.v1beta1.IBackup, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Backup message. Does not implicitly messages.

Parameters
NameDescription
message IBackup

Backup 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.filestore.v1beta1.IBackup, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBackup

Backup 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.filestore.v1beta1.Backup;

Creates a Backup 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.filestore.v1beta1.Backup

Backup

toJSON()

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

Converts this Backup to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.filestore.v1beta1.Backup

Backup

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