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

Represents a FileShareConfig.

Package

@google-cloud/filestore

Constructors

(constructor)(properties)

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

Constructs a new FileShareConfig.

Parameter
NameDescription
properties IFileShareConfig

Properties to set

Properties

capacityGb

public capacityGb: (number|Long|string);

FileShareConfig capacityGb.

name

public name: string;

FileShareConfig name.

nfsExportOptions

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

FileShareConfig nfsExportOptions.

source

public source?: "sourceBackup";

FileShareConfig source.

sourceBackup

public sourceBackup?: (string|null);

FileShareConfig sourceBackup.

Methods

create(properties)

public static create(properties?: google.cloud.filestore.v1beta1.IFileShareConfig): google.cloud.filestore.v1beta1.FileShareConfig;

Creates a new FileShareConfig instance using the specified properties.

Parameter
NameDescription
properties IFileShareConfig

Properties to set

Returns
TypeDescription
FileShareConfig

FileShareConfig instance

decode(reader, length)

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

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

FileShareConfig

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
FileShareConfig

FileShareConfig

encode(message, writer)

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

Encodes the specified FileShareConfig message. Does not implicitly messages.

Parameters
NameDescription
message IFileShareConfig

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

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

Parameters
NameDescription
message IFileShareConfig

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

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

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

Plain object

Returns
TypeDescription
FileShareConfig

FileShareConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FileShareConfig

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message FileShareConfig

FileShareConfig

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