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

Represents a BackupPolicy.

Package

@google-cloud/netapp

Constructors

(constructor)(properties)

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

Constructs a new BackupPolicy.

Parameter
Name Description
properties IBackupPolicy

Properties to set

Properties

_assignedVolumeCount

public _assignedVolumeCount?: "assignedVolumeCount";

BackupPolicy _assignedVolumeCount.

_dailyBackupLimit

public _dailyBackupLimit?: "dailyBackupLimit";

BackupPolicy _dailyBackupLimit.

_description

public _description?: "description";

BackupPolicy _description.

_enabled

public _enabled?: "enabled";

BackupPolicy _enabled.

_monthlyBackupLimit

public _monthlyBackupLimit?: "monthlyBackupLimit";

BackupPolicy _monthlyBackupLimit.

_weeklyBackupLimit

public _weeklyBackupLimit?: "weeklyBackupLimit";

BackupPolicy _weeklyBackupLimit.

assignedVolumeCount

public assignedVolumeCount?: (number|null);

BackupPolicy assignedVolumeCount.

createTime

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

BackupPolicy createTime.

dailyBackupLimit

public dailyBackupLimit?: (number|null);

BackupPolicy dailyBackupLimit.

description

public description?: (string|null);

BackupPolicy description.

enabled

public enabled?: (boolean|null);

BackupPolicy enabled.

labels

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

BackupPolicy labels.

monthlyBackupLimit

public monthlyBackupLimit?: (number|null);

BackupPolicy monthlyBackupLimit.

name

public name: string;

BackupPolicy name.

state

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

BackupPolicy state.

weeklyBackupLimit

public weeklyBackupLimit?: (number|null);

BackupPolicy weeklyBackupLimit.

Methods

create(properties)

public static create(properties?: google.cloud.netapp.v1.IBackupPolicy): google.cloud.netapp.v1.BackupPolicy;

Creates a new BackupPolicy instance using the specified properties.

Parameter
Name Description
properties IBackupPolicy

Properties to set

Returns
Type Description
BackupPolicy

BackupPolicy instance

decode(reader, length)

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

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

BackupPolicy

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BackupPolicy

BackupPolicy

encode(message, writer)

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

Encodes the specified BackupPolicy message. Does not implicitly messages.

Parameters
Name Description
message IBackupPolicy

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

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

Parameters
Name Description
message IBackupPolicy

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

Creates a BackupPolicy 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
BackupPolicy

BackupPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BackupPolicy

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message BackupPolicy

BackupPolicy

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