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

Represents a Share.

Package

@google-cloud/filestore

Constructors

(constructor)(properties)

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

Constructs a new Share.

Parameter
NameDescription
properties IShare

Properties to set

Properties

backup

public backup?: (string|null);

Share backup.

capacityGb

public capacityGb: (number|Long|string);

Share capacityGb.

createTime

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

Share createTime.

description

public description: string;

Share description.

labels

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

Share labels.

mountName

public mountName: string;

Share mountName.

name

public name: string;

Share name.

nfsExportOptions

public nfsExportOptions: google.cloud.filestore.v1beta1.INfsExportOptions[];

Share nfsExportOptions.

source

public source?: "backup";

Share source.

state

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

Share state.

Methods

create(properties)

public static create(properties?: google.cloud.filestore.v1beta1.IShare): google.cloud.filestore.v1beta1.Share;

Creates a new Share instance using the specified properties.

Parameter
NameDescription
properties IShare

Properties to set

Returns
TypeDescription
Share

Share instance

decode(reader, length)

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

Decodes a Share 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
Share

Share

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Share

Share

encode(message, writer)

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

Encodes the specified Share message. Does not implicitly messages.

Parameters
NameDescription
message IShare

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

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

Parameters
NameDescription
message IShare

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

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

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

Plain object

Returns
TypeDescription
Share

Share

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Share

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Share

Share

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