Class protos.google.cloud.netapp.v1.Volume (0.2.1)

Represents a Volume.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.netapp.v1.IVolume);

Constructs a new Volume.

Parameter
Name	Description
`properties`	`IVolume` Properties to set

Properties

_backupConfig

public _backupConfig?: "backupConfig";

Volume _backupConfig.

activeDirectory

public activeDirectory: string;

Volume activeDirectory.

backupConfig

public backupConfig?: (google.cloud.netapp.v1.IBackupConfig|null);

Volume backupConfig.

capacityGib

public capacityGib: (number|Long|string);

Volume capacityGib.

createTime

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

Volume createTime.

description

public description: string;

Volume description.

encryptionType

public encryptionType: (google.cloud.netapp.v1.EncryptionType|keyof typeof google.cloud.netapp.v1.EncryptionType);

Volume encryptionType.

exportPolicy

public exportPolicy?: (google.cloud.netapp.v1.IExportPolicy|null);

Volume exportPolicy.

hasReplication

public hasReplication: boolean;

Volume hasReplication.

kerberosEnabled

public kerberosEnabled: boolean;

Volume kerberosEnabled.

kmsConfig

public kmsConfig: string;

Volume kmsConfig.

labels

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

Volume labels.

ldapEnabled

public ldapEnabled: boolean;

Volume ldapEnabled.

mountOptions

public mountOptions: google.cloud.netapp.v1.IMountOption[];

Volume mountOptions.

name

public name: string;

Volume name.

network

public network: string;

Volume network.

protocols

public protocols: google.cloud.netapp.v1.Protocols[];

Volume protocols.

psaRange

public psaRange: string;

Volume psaRange.

restoreParameters

public restoreParameters?: (google.cloud.netapp.v1.IRestoreParameters|null);

Volume restoreParameters.

restrictedActions

public restrictedActions: google.cloud.netapp.v1.RestrictedAction[];

Volume restrictedActions.

securityStyle

public securityStyle: (google.cloud.netapp.v1.SecurityStyle|keyof typeof google.cloud.netapp.v1.SecurityStyle);

Volume securityStyle.

serviceLevel

public serviceLevel: (google.cloud.netapp.v1.ServiceLevel|keyof typeof google.cloud.netapp.v1.ServiceLevel);

Volume serviceLevel.

shareName

public shareName: string;

Volume shareName.

smbSettings

public smbSettings: google.cloud.netapp.v1.SMBSettings[];

Volume smbSettings.

snapReserve

public snapReserve: number;

Volume snapReserve.

snapshotDirectory

public snapshotDirectory: boolean;

Volume snapshotDirectory.

snapshotPolicy

public snapshotPolicy?: (google.cloud.netapp.v1.ISnapshotPolicy|null);

Volume snapshotPolicy.

state

public state: (google.cloud.netapp.v1.Volume.State|keyof typeof google.cloud.netapp.v1.Volume.State);

Volume state.

stateDetails

public stateDetails: string;

Volume stateDetails.

storagePool

public storagePool: string;

Volume storagePool.

unixPermissions

public unixPermissions: string;

Volume unixPermissions.

usedGib

public usedGib: (number|Long|string);

Volume usedGib.

Methods

create(properties)

public static create(properties?: google.cloud.netapp.v1.IVolume): google.cloud.netapp.v1.Volume;

Creates a new Volume instance using the specified properties.

Parameter
Name	Description
`properties`	`IVolume` Properties to set

Returns
Type	Description
`Volume`	Volume instance

decode(reader, length)

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

Decodes a Volume message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`Volume`	Volume

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`Volume`	Volume

encode(message, writer)

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

Encodes the specified Volume message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IVolume` Volume message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.netapp.v1.IVolume, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IVolume` Volume message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.netapp.v1.Volume;

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

Parameter
Name	Description
`object`	`{ [k: string]: any }` Plain object

Returns
Type	Description
`Volume`	Volume

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Volume

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

toJSON()

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

Converts this Volume to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`Volume` Volume
`options`	`$protobuf.IConversionOptions` Conversion options

Returns
Type	Description
`{ [k: string]: any }`	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Volume message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not