Class protos.google.cloud.filestore.v1beta1.Snapshot (3.3.0)

Represents a Snapshot.

Package

@google-cloud/filestore

Constructors

(constructor)(properties)

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

Constructs a new Snapshot.

Parameter
NameDescription
properties ISnapshot

Properties to set

Properties

createTime

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

Snapshot createTime.

description

public description: string;

Snapshot description.

filesystemUsedBytes

public filesystemUsedBytes: (number|Long|string);

Snapshot filesystemUsedBytes.

labels

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

Snapshot labels.

name

public name: string;

Snapshot name.

state

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

Snapshot state.

Methods

create(properties)

public static create(properties?: google.cloud.filestore.v1beta1.ISnapshot): google.cloud.filestore.v1beta1.Snapshot;

Creates a new Snapshot instance using the specified properties.

Parameter
NameDescription
properties ISnapshot

Properties to set

Returns
TypeDescription
Snapshot

Snapshot instance

decode(reader, length)

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

Decodes a Snapshot message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Snapshot

Snapshot

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Snapshot

Snapshot

encode(message, writer)

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

Encodes the specified Snapshot message. Does not implicitly messages.

Parameters
NameDescription
message ISnapshot

Snapshot 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.ISnapshot, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISnapshot

Snapshot 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.Snapshot;

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

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

Plain object

Returns
TypeDescription
Snapshot

Snapshot

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Snapshot

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Snapshot to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Snapshot

Snapshot

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